Collections

Search Collections

post

Searches for collections based on provided filters.

Body

namestringoptional

sortobject[]optional

limitinteger · min: 1 · max: 100optional

offsetintegeroptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://indexer-dev.saturnbtc.io/v0/collection/multi-search' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "sort": [
      {
        "field": null,
        "order": null
      }
    ],
    "limit": 1,
    "offset": 1
  }'

201

201

{
  "response": [
    {
      "id": "text",
      "name": "text",
      "displayName": "text",
      "symbol": "text",
      "tradeable": true,
      "verified": true,
      "icon": null,
      "priority": 1,
      "type": null,
      "divisibility": 1,
      "supply": "text",
      "batchSize": "text",
      "transactionId": "text",
      "createdAt": "text"
    }
  ],
  "offset": 1
}

A paginated response containing an array of collections.

Search Mintable Collections

post

Searches for mintable collections based on provided filters.

Body

namestringoptional

sortobject[]optional

limitinteger · min: 1 · max: 100optional

offsetintegeroptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://indexer-dev.saturnbtc.io/v0/collection/mintable/multi-search' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "sort": [
      {
        "field": null,
        "order": null
      }
    ],
    "limit": 1,
    "offset": 1
  }'

201

201

{
  "response": [
    {
      "mint": {
        "amount": "text",
        "cap": "text",
        "mintable": true,
        "start": "text",
        "end": "text",
        "mints": "text",
        "progress": 1
      },
      "id": "text",
      "name": "text",
      "displayName": "text",
      "symbol": "text",
      "tradeable": true,
      "verified": true,
      "icon": null,
      "priority": 1,
      "type": null,
      "divisibility": 1,
      "supply": "text",
      "batchSize": "text",
      "transactionId": "text",
      "createdAt": "text"
    }
  ],
  "offset": 1
}

A paginated response containing an array of mintable collections.

Get Mintable Collection by ID

get

Retrieves a mintable collection by its ID.

Path parameters

idstringrequired

The ID of the mintable collection.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://indexer-dev.saturnbtc.io/v0/collection/mintable/{id}'

200

200

{
  "mint": {
    "amount": "text",
    "cap": "text",
    "mintable": true,
    "start": "text",
    "end": "text",
    "mints": "text",
    "progress": 1
  },
  "id": "text",
  "name": "text",
  "displayName": "text",
  "symbol": "text",
  "tradeable": true,
  "verified": true,
  "icon": null,
  "priority": 1,
  "type": null,
  "divisibility": 1,
  "supply": "text",
  "batchSize": "text",
  "transactionId": "text",
  "createdAt": "text"
}

The mintable collection with the specified ID.

Get Collection by ID

get

Retrieves a collection by its ID.

Path parameters

idstringrequired

The ID of the collection.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://indexer-dev.saturnbtc.io/v0/collection/id/{id}'

200

200

{
  "id": "text",
  "name": "text",
  "displayName": "text",
  "symbol": "text",
  "tradeable": true,
  "verified": true,
  "icon": null,
  "priority": 1,
  "type": null,
  "divisibility": 1,
  "supply": "text",
  "batchSize": "text",
  "transactionId": "text",
  "createdAt": "text"
}

The collection with the specified ID.

Get Collection by Name

get

Retrieves a collection by its name.

Path parameters

namestringrequired

The name of the collection.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://indexer-dev.saturnbtc.io/v0/collection/name/{name}'

200

200

{
  "id": "text",
  "name": "text",
  "displayName": "text",
  "symbol": "text",
  "tradeable": true,
  "verified": true,
  "icon": null,
  "priority": 1,
  "type": null,
  "divisibility": 1,
  "supply": "text",
  "batchSize": "text",
  "transactionId": "text",
  "createdAt": "text"
}

The collection with the specified name.

Get Collections by IDs

get

Retrieves multiple collections by their IDs.

Query parameters

idsstring[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://indexer-dev.saturnbtc.io/v0/collection/ids?ids=text'

200

200

[
  {
    "id": "text",
    "name": "text",
    "displayName": "text",
    "symbol": "text",
    "tradeable": true,
    "verified": true,
    "icon": null,
    "priority": 1,
    "type": null,
    "divisibility": 1,
    "supply": "text",
    "batchSize": "text",
    "transactionId": "text",
    "createdAt": "text"
  }
]

An array of collections matching the provided IDs.

Get Collections by Names

get

Retrieves multiple collections by their names.

Query parameters

namesstring[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://indexer-dev.saturnbtc.io/v0/collection/names?names=text'

200

200

[
  {
    "id": "text",
    "name": "text",
    "displayName": "text",
    "symbol": "text",
    "tradeable": true,
    "verified": true,
    "icon": null,
    "priority": 1,
    "type": null,
    "divisibility": 1,
    "supply": "text",
    "batchSize": "text",
    "transactionId": "text",
    "createdAt": "text"
  }
]

An array of collections matching the provided names.