# getOrdinalsCollectionsByAddress

**Identifier:** `xverse_getOrdinalsCollectionsByAddress`

**Provider:** [Xverse](https://kirha.com/providers/xverse.md)

List ordinals collection owned by a given bitcoin address. This tool provides market data

## Run it with the CLI

```bash
kirha tools run xverse_getOrdinalsCollectionsByAddress \
  --input '{
    "address": "<address>"
  }'
```

`--input` takes a JSON object that matches the input schema. Pass `--input -` to read it from stdin.

## Call it over HTTP

```bash
curl https://api.kirha.com/tools/v1/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: **********' \
  --data '{
  "tool_name": "xverse_getOrdinalsCollectionsByAddress",
  "input": {
    "address": "<address>"
  }
}'
```

Replace the stars with an API key from https://app.kirha.com/api-keys.

## Input schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "address": {
      "description": "Bitcoin address",
      "type": "string"
    },
    "limit": {
      "default": 5,
      "description": "The number of ordinals collections to return",
      "maximum": 60,
      "minimum": 1,
      "type": "number"
    }
  },
  "required": [
    "address"
  ],
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "collections": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "description": {
            "type": "string"
          },
          "floorPriceSats": {
            "type": "string"
          },
          "floorPriceUsd": {
            "type": "string"
          },
          "holderCount": {
            "type": "string"
          },
          "inscriptionSubset": {
            "items": {
              "additionalProperties": false,
              "properties": {
                "contentType": {
                  "type": "string"
                },
                "id": {
                  "type": "string"
                },
                "number": {
                  "type": "number"
                }
              },
              "required": [
                "id",
                "number",
                "contentType"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "links": {
            "additionalProperties": false,
            "properties": {
              "coinMarketCap": {
                "type": "string"
              },
              "discord": {
                "type": "string"
              },
              "telegram": {
                "type": "string"
              },
              "twitter": {
                "type": "string"
              },
              "website": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "marketCapSats": {
            "type": "string"
          },
          "marketCapUsd": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "supply": {
            "type": "string"
          },
          "symbol": {
            "type": "string"
          },
          "total": {
            "type": "number"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "context": {
      "type": "string"
    }
  },
  "required": [
    "context",
    "collections"
  ],
  "type": "object"
}
```

-----

[All Xverse tools](https://kirha.com/providers/xverse.md) · [< Back to tools list](https://kirha.com/tools.md)