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 |
price* | Number | Inscription price per file (for collection creator) set to 0 for free mints |
totalCount* | Number | Max supply of the collection. |
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 }, } |
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>
Last updated