> For the complete documentation index, see [llms.txt](https://ordnull.gitbook.io/api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ordnull.gitbook.io/api/compatibility-apis/collections.md).

# Collections

#### **Collections API**

Our Collections API endpoints provide detailed access to **BTC Ordinals** and **Runes** collection data. Effortlessly retrieve:

* **Collection Summaries**: Key statistics and overviews.
* **Individual Collection Details**: Granular insights into specific collections.
* **Historical and Real-Time Data**: Power your tools with the most accurate information available.

## Get Collection Listings

> Returns ordered list of listings of a specific collection

```json
{"openapi":"3.0.0","info":{"title":"Ordinals & Runes Compatibility API","version":"3.0"},"servers":[{"url":"https://api.ordnull.site/v3","description":"Production server"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-Key"}},"schemas":{"ListingData":{"type":"object","properties":{"inscription_id":{"type":"string"},"min_price":{"type":"integer","nullable":true},"ordswap_price":{"type":"integer","nullable":true},"magiceden_price":{"type":"integer","nullable":true},"ordinalswallet_price":{"type":"integer","nullable":true},"gammaio_price":{"type":"integer","nullable":true},"nostr_price":{"type":"integer","nullable":true},"odynals_price":{"type":"integer","nullable":true},"unisat_price":{"type":"integer","nullable":true},"ordinalsmarket_price":{"type":"integer","nullable":true},"okx_price":{"type":"integer","nullable":true},"owner_wallet_addr":{"type":"string"}}},"Error":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}},"paths":{"/collection/listings":{"get":{"summary":"Get Collection Listings","description":"Returns ordered list of listings of a specific collection","parameters":[{"name":"sort_by","in":"query","required":true,"schema":{"type":"string","enum":["min_price","ordswap_price","magiceden_price","ordinalswallet_price","gammaio_price","odynals_price","unisat_price","ordinalsmarket_price","okx_price"]}},{"name":"order","in":"query","required":true,"schema":{"type":"string","enum":["asc","desc"]}},{"name":"offset","in":"query","required":true,"schema":{"type":"integer","minimum":0,"maximum":5000}},{"name":"count","in":"query","required":true,"schema":{"type":"integer","minimum":20,"maximum":200}},{"name":"slug","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ListingData"}},"block_height":{"type":"integer"}}}}}},"403":{"description":"Invalid API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```

## Get Collections

> Returns ordered list of collections with detailed information

```json
{"openapi":"3.0.0","info":{"title":"Ordinals & Runes Compatibility API","version":"3.0"},"servers":[{"url":"https://api.ordnull.site/v3","description":"Production server"}],"paths":{"/collection/collections":{"get":{"summary":"Get Collections","description":"Returns ordered list of collections with detailed information","parameters":[{"name":"sort_by","in":"query","required":true,"schema":{"type":"string","enum":["supply","min_number","median_number","max_number","listed_count","floor_price","floor_price_ordswap","floor_price_magiceden","floor_price_ordinalswallet","floor_price_gammaio","floor_price_ordynals","floor_price_ordinalsmarket","floor_price_unisat","floor_price_okx","vol_24h_in_btc","vol_7d_in_btc","sale_cnt_7d","vol_total_in_btc","sale_cnt_total","marketcap"]}},{"name":"order","in":"query","required":true,"schema":{"type":"string","enum":["asc","desc"]}},{"name":"offset","in":"query","required":true,"schema":{"type":"integer","minimum":0}},{"name":"count","in":"query","required":true,"schema":{"type":"integer","minimum":20,"maximum":200}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CollectionData"}},"block_height":{"type":"integer"}}}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"CollectionData":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"inscription_icon_id":{"type":"string"},"icon_url":{"type":"string"},"icon_render_url":{"type":"string","nullable":true},"bis_url":{"type":"string"},"supply":{"type":"string"},"min_number":{"type":"integer"},"median_number":{"type":"integer"},"max_number":{"type":"integer"},"listed_count":{"type":"integer"},"floor_price":{"type":"integer"},"floor_price_ordswap":{"type":"integer","nullable":true},"floor_price_magiceden":{"type":"integer","nullable":true},"floor_price_ordinalswallet":{"type":"integer","nullable":true},"floor_price_gammaio":{"type":"integer","nullable":true},"floor_price_ordynals":{"type":"integer","nullable":true},"floor_price_ordinalsmarket":{"type":"integer","nullable":true},"floor_price_unisat":{"type":"integer","nullable":true},"floor_price_okx":{"type":"integer","nullable":true},"vol_24h_in_btc":{"type":"number"},"vol_7d_in_btc":{"type":"number"},"sale_cnt_7d":{"type":"integer"},"vol_total_in_btc":{"type":"number"},"sale_cnt_total":{"type":"integer"},"marketcap":{"type":"integer"}}},"Error":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}}
```

## Get Collection Information

> Returns detailed information about a specific collection

```json
{"openapi":"3.0.0","info":{"title":"Ordinals & Runes Compatibility API","version":"3.0"},"servers":[{"url":"https://api.ordnull.site/v3","description":"Production server"}],"paths":{"/collection/info":{"get":{"summary":"Get Collection Information","description":"Returns detailed information about a specific collection","parameters":[{"name":"slug","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CollectionInfo"},"block_height":{"type":"integer"}}}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"components":{"schemas":{"CollectionInfo":{"type":"object","properties":{"name":{"type":"string"},"twitter_link":{"type":"string"},"discord_link":{"type":"string"},"website_link":{"type":"string"},"description":{"type":"string"},"supply":{"type":"string"},"inscription_icon_id":{"type":"string"},"min_number":{"type":"integer"},"median_number":{"type":"integer"},"max_number":{"type":"integer"},"icon_url":{"type":"string"},"icon_render_url":{"type":"string"},"bis_url":{"type":"string"}}},"Error":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}}}
```

## Get Collection Sales Information

> Returns sales and volume information about a specific collection

```json
{"openapi":"3.0.0","info":{"title":"Ordinals & Runes Compatibility API","version":"3.0"},"servers":[{"url":"https://api.ordnull.site/v3","description":"Production server"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-Key"}},"schemas":{"SalesInfo":{"type":"object","properties":{"vol_3h":{"type":"string"},"vol_6h":{"type":"string"},"vol_9h":{"type":"string"},"vol_12h":{"type":"string"},"vol_1d":{"type":"string"},"vol_3d":{"type":"string"},"vol_7d":{"type":"string"},"vol_30d":{"type":"string"},"vol_total":{"type":"string"},"sale_count":{"type":"integer"},"marketplace":{"type":"string"}}},"Error":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}},"paths":{"/collection/sales_info":{"get":{"summary":"Get Collection Sales Information","description":"Returns sales and volume information about a specific collection","parameters":[{"name":"slug","in":"query","required":true,"schema":{"type":"string"}},{"name":"marketplace_type","in":"query","schema":{"type":"string","enum":["magiceden","ordinals.market","gamma.io","ordinals_wallet","ordswap","openordex","okx","unisat","ordinalnovus"]}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SalesInfo"},"block_height":{"type":"integer"}}}}}},"403":{"description":"Invalid API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```

## Get Collection Listing Changes

> Returns recent changes in collection listings across different marketplaces

```json
{"openapi":"3.0.0","info":{"title":"Ordinals & Runes Compatibility API","version":"3.0"},"servers":[{"url":"https://api.ordnull.site/v3","description":"Production server"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-Key"}},"schemas":{"ListingChangeData":{"type":"object","properties":{"marketplace":{"type":"string","description":"Name of the marketplace","enum":["magiceden","ordswap","ordinalswallet","gammaio","nostr","odynals","unisat","ordinalsmarket","okx"]},"slug":{"type":"string","description":"Collection slug"},"inscription_id":{"type":"string","description":"Inscription ID"},"price":{"type":"integer","nullable":true,"description":"Price in sats"},"is_listed":{"type":"boolean","description":"Whether the inscription is listed"},"change_ts":{"type":"integer","description":"Timestamp of the change"}}},"Error":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}},"paths":{"/x/collection/listing_changes":{"get":{"summary":"Get Collection Listing Changes","description":"Returns recent changes in collection listings across different marketplaces","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ListingChangeData"}},"block_height":{"type":"integer","description":"Current block height"}}}}}},"403":{"description":"Invalid API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```

## Get Inscription Activity in Block

> Returns the inscription activity on a given block height

```json
{"openapi":"3.0.0","info":{"title":"Ordinals & Runes Compatibility API","version":"3.0"},"servers":[{"url":"https://api.ordnull.site/v3","description":"Production server"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-Key"}},"schemas":{"ActivityData":{"type":"object","properties":{"inscription_id":{"type":"string"},"from_wallet":{"type":"string","nullable":true},"to_wallet":{"type":"string"},"block_height":{"type":"integer"},"sale_price":{"type":"integer","nullable":true},"new_satpoint":{"type":"string"},"ts":{"type":"string"},"marketplace_type":{"type":"string"},"inscription_name":{"type":"string","nullable":true},"inscription_number":{"type":"integer","nullable":true},"collection_name":{"type":"string","nullable":true},"collection_slug":{"type":"string","nullable":true},"tx_id":{"type":"string"},"is_me_cpfp_bundle":{"type":"boolean","nullable":true},"me_cpfp_bundle_hash":{"type":"string","nullable":true},"me_cpfp_final_destination_wallet":{"type":"string","nullable":true}}},"Error":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}}}}},"paths":{"/inscription/activity_on_block":{"get":{"summary":"Get Inscription Activity in Block","description":"Returns the inscription activity on a given block height","parameters":[{"name":"block_height","in":"query","required":true,"schema":{"type":"integer"}},{"name":"order","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"sort_by","in":"query","schema":{"type":"string","enum":["ts"]}},{"name":"activity_filter","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ActivityData"}},"block_height":{"type":"integer"}}}}}},"403":{"description":"Invalid API Key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```

#### **Want Access? Request Your API Key!**

*Like what you see? Take the next step!*\
👉 [**Fill out the form on our website**](https://www.chaindaq.com/plans) to request your API key and unlock access to all our Collections endpoints.