Create a Collection

Use these endpoints to create a collection that other users will be able to create orders on and inscribe on demand.

All collections must be approved by the ordinalsbot.com team before they go live.

Collections with over 1000 items need to be manually uploaded.

Get in touch with us on Discord.

The /order endpoint has a rate limit of 2 requests per 10 seconds.A

Create Collection

POST https://api.ordinalsbot.com/collection-create

Use this method to create a collection, if your files are already on a publicly accessible URL.

Headers

Name	Type	Description
Content-Type	String	application/json

Request Body

Name	Type	Description
files	Object	An array of objects that includes: name:string; => name of the file including extension. size:number; => size of the file in bytes url:string; => publicly accessible image URL You can also provide files manually after contacting us.
id*	String	URL safe unique collection slug. Will be used as mint URL.
name*	String	Collection Display Name
description*	String	Collection description
creator*	String	Collection creator
totalCount*	Number	Max supply of the collection.
price	Number	Inscription price per file (for collection creator) set to 0 for free mints
altPrices	Object	Price item in collection with rune tokens. Any rune token can be used. Parameters: rune => rune price object rune price object => amount rune price object => token example: { "rune": { "amount": 1, "token": "SHITCOIN•PARADISE" } }
twitter	String	Collection twitter account
website	String	Collection website
banner	String	Collection banner image URL
cover	String	Collection cover image URL
creator-address	String	Bitcoin address to receive payouts from inscriptions
allowList	Object	allowList object in this format { "address1": { "allocation": 5 }, "address2": { "allocation": 3 }, }

200: OK

{
    status: 'ok',
    ..., // input parameters
    createdAt: 1675785959855, // timestamp in ms,
}

500: Internal Server Error

{
    status: 'error',
    error: 'error reason'
}

As a collection creator, if you need access to inscription IDs from your collection you can access them here: https://api.ordinalsbot.com/get-collection-json?id=<collection-id>

Get Collection JSON

GET https://api.ordinalsbot.com/get-collection-json

Use this method to get a collection json, that is usable by marketplaces for secondary market listing.

Request Parameters

Name	Type	Description
id*	String	URL safe unique collection ID of the collection on OrdinalsBot
onchainFormat	Boolean	Set to true if you prefer to have the collection json in EVM friendly format.

200: OK

[
    {
        "id": "0c3d76bfbe081ffe3c447348b1f45e373a60b267ca3de96a46ab59473dab2c2bi0",
        "meta": {
            "attributes": {
                "inscribed_by": "OrdinalsBot"
            },
            "name": "Pixlbot Test 1 #1"
        }
    },
    ...
]

200: OK

// onchainFormat=true
[
    {
        "id": "0c3d76bfbe081ffe3c447348b1f45e373a60b267ca3de96a46ab59473dab2c2bi0",
        "meta": {
            "inscribed_by": "OrdinalsBot",
            "name": "Pixlbot Test 1 #1"
        }
    },
    {
        "id": "568d0c679af7f9c6304c55841b781eb72c4e5535fb8451322ed3e243b52e1584i0",
        "meta": {
            "inscribed_by": "OrdinalsBot",
            "name": "Pixlbot Test 1 #2"
        }
    },
    ...
]

500: Internal Server Error

{
    status: 'error',
    error: 'error reason'
}