Collections

A route that returns all NFT collections or domains listed on your platform

Fetch collections

GET https://api.yourapi.com/v1/collections

Good to know: The Body block here means response body returns from yours, not request body from us, just for easier representation.

Query Parameters

Name	Type	Description
nft_type	string	collection, or domain

Headers

Name	Type	Description
ordyssey_http*	string	We usually use this HTTP header to allow your server identify us, or we can engage in a discussion to provide a private API token. In certain cooperative scenarios, it is important for you to be aware that the HTTP request originates from our side for the purpose of tracking contributions.

Request Body

Name	Type	Description
slug*	string	The unique identifier (no space here) of the collection in your database and routes to developers
nft_type*	string	collection, or domain
supply*	int	The inscriptions number of the collection, we use it to check if the inscriptions under the collection are fully synced by us.
listed*	int	The listed inscriptions number of the collection, we use it to check if the listings under the collection are fully synced by us.
name*	string	The identifier (can have space here) of the collection in your Web UI to users
floor_price*	int	The floor price (in sats) of the collection, we use it to check if the best prices (which has highest frequency of user access in page 1) under the collection are fully synced by us.
platform*	string	Your platform identifier (no space here)
domain_type	string	if .sats, set sats here if .bitmap, set bitmap here if non-domain NFT collection, set blank here

200 Collections successfully returned

[
        {
            "slug": "bitcoin-frogs",
            "name": "Bitcoin Frogs",
            "nft_type": "collection",
            "domain_type": null,    // non-domain NFT collection, set null here
            "supply": 1024,
            "listed": 60,
            "floor_price": 7000000, // in sats
            "platform": "idclub"
        },
        {
            "slug": "domain_dot_sats",
            "name": "Sat Names",
            "nft_type": "domain",  // collection, domain
            "domain_type": "sats",  // if .sats, set 'sats' here
            "supply": 100023,
            "listed": 6012,
            "floor_price": 8000000, // in sats
            "platform": "ordzaar"
        },
        {
            "slug": "domain_dot_bitmap",
            "name": "Bitmap",
            "nft_type": "domain",  // collection, domain
            "domain_type": "bitmap",  // if .bitmap, set 'bitmap' here
            "supply": 807002,
            "listed": 6012,
            "floor_price": 9000000, // in sats
            "platform": "ordzaar"
        }
        ]

401 Permission denied

Good to know: The Body block here means response body returns from yours, not request body from us, just for easier representation.