Inscriptions

A route that returns inscriptions under the collection or domain listed on your platform

Fetch inscriptions

Fetch data relationship between a collection and its inscriptions

GET https://api/yourapi.com/v1/inscriptions/{collection_slug}

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

Path Parameters

Name	Type	Description
collection_slug*	String	The identifier of the collection in your database

Query Parameters

Name	Type	Description
listed	bool	If true , only return listed inscriptions of the collection If blank, return all
limit	int	100
offset	int	0

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
inscription_id*	String	The identifier of the listed inscription, which is generated by Ordinals protocol. Such as e583ba055949cd05bb145249b20dd5076cb81d46e0bb84158a17305fcc77aa05i0

200: OK

[
        {
            "inscription_id": "e583ba055949cd05bb145249b20dd5076cb81d46e0bb84158a17305fcc77aa05i0",
            // ...
        },
        {
            "inscription_id": "e583ba888889cd05bb145249b20dd5076cb81d46e0bb84158a17305fcc77aa05i0",        
            // ...    
        }
]