# getOrdinalsCollection

**Identifier:** `xverse_getOrdinalsCollection`

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

Get metadata and market information for a specific ordinal collection

## Run it with the CLI

```bash
kirha tools run xverse_getOrdinalsCollection \
  --input '{
    "collectionId": "<collectionId>"
  }'
```

`--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_getOrdinalsCollection",
  "input": {
    "collectionId": "<collectionId>"
  }
}'
```

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": {
    "collectionId": {
      "description": "The ID of the ordinals collection to retrieve",
      "type": "string"
    }
  },
  "required": [
    "collectionId"
  ],
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "context": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "floorPriceChange24hSats": {
      "type": "string"
    },
    "floorPriceChange24hUsd": {
      "type": "string"
    },
    "floorPriceSats": {
      "type": "string"
    },
    "floorPriceUsd": {
      "type": "string"
    },
    "holderCount": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "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"
    },
    "volume24hChangeSats": {
      "type": "string"
    },
    "volume24hChangeUsd": {
      "type": "string"
    },
    "volume24hSats": {
      "type": "string"
    },
    "volume24hUsd": {
      "type": "string"
    }
  },
  "required": [
    "context"
  ],
  "type": "object"
}
```

-----

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