Collections

Search Collections

Searches for collections based on provided filters.

POSThttps://indexer-dev.saturnbtc.io/v0/collection/multi-search

Body

application/json

The filter criteria for searching collections.

namestring

sortarray of SortFieldSorteableCollectionFields (object)

limitinteger

offsetinteger

Response

201

A paginated response containing an array of collections.

Body

application/json

response*array of object

offset*number

Request

JavaScriptCurlPython

const response = await fetch('https://indexer-dev.saturnbtc.io/v0/collection/multi-search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

{
  "response": [
    {
      "id": "text",
      "name": "text",
      "displayName": "text",
      "symbol": "text",
      "tradeable": false,
      "verified": false,
      "icon": "text",
      "priority": 0,
      "divisibility": 0,
      "supply": "text",
      "batchSize": "text",
      "transactionId": "text",
      "createdAt": "text"
    }
  ],
  "offset": 0
}

Search Mintable Collections

Searches for mintable collections based on provided filters.

POSThttps://indexer-dev.saturnbtc.io/v0/collection/mintable/multi-search

Body

application/json

The filter criteria for searching mintable collections.

namestring

sortarray of SortFieldSorteableMintableCollectionFields (object)

limitinteger

offsetinteger

Response

201

A paginated response containing an array of mintable collections.

Body

application/json

response*array of object

offset*number

Request

JavaScriptCurlPython

const response = await fetch('https://indexer-dev.saturnbtc.io/v0/collection/mintable/multi-search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201

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

Get Mintable Collection by ID

Retrieves a mintable collection by its ID.

GEThttps://indexer-dev.saturnbtc.io/v0/collection/mintable/{id}

Path parameters

id*string

The ID of the mintable collection.

Response

200

The mintable collection with the specified ID.

Body

application/json

mintobject

id*string

name*string

displayName*string

symbol*string

tradeable*boolean

verified*boolean

icon*string

priority*number

type*one of

anyanyany

divisibility*number

supply*string

batchSize*string

transactionIdstring

createdAt*string

Request

JavaScriptCurlPython

const response = await fetch('https://indexer-dev.saturnbtc.io/v0/collection/mintable/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Get Collection by ID

Retrieves a collection by its ID.

GEThttps://indexer-dev.saturnbtc.io/v0/collection/id/{id}

Path parameters

id*string

The ID of the collection.

Response

200

The collection with the specified ID.

Body

application/json

id*string

name*string

displayName*string

symbol*string

tradeable*boolean

verified*boolean

icon*string

priority*number

type*one of

anyanyany

divisibility*number

supply*string

batchSize*string

transactionIdstring

createdAt*string

Request

JavaScriptCurlPython

const response = await fetch('https://indexer-dev.saturnbtc.io/v0/collection/id/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "displayName": "text",
  "symbol": "text",
  "tradeable": false,
  "verified": false,
  "icon": "text",
  "priority": 0,
  "divisibility": 0,
  "supply": "text",
  "batchSize": "text",
  "transactionId": "text",
  "createdAt": "text"
}

Get Collection by Name

Retrieves a collection by its name.

GEThttps://indexer-dev.saturnbtc.io/v0/collection/name/{name}

Path parameters

name*string

The name of the collection.

Response

200

The collection with the specified name.

Body

application/json

id*string

name*string

displayName*string

symbol*string

tradeable*boolean

verified*boolean

icon*string

priority*number

type*one of

anyanyany

divisibility*number

supply*string

batchSize*string

transactionIdstring

createdAt*string

Request

JavaScriptCurlPython

const response = await fetch('https://indexer-dev.saturnbtc.io/v0/collection/name/{name}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "name": "text",
  "displayName": "text",
  "symbol": "text",
  "tradeable": false,
  "verified": false,
  "icon": "text",
  "priority": 0,
  "divisibility": 0,
  "supply": "text",
  "batchSize": "text",
  "transactionId": "text",
  "createdAt": "text"
}

Get Collections by IDs

Retrieves multiple collections by their IDs.

GEThttps://indexer-dev.saturnbtc.io/v0/collection/ids

Query parameters

Response

200

An array of collections matching the provided IDs.

Body

application/json

id*string

name*string

displayName*string

symbol*string

tradeable*boolean

verified*boolean

icon*string

priority*number

type*one of

anyanyany

divisibility*number

supply*string

batchSize*string

transactionIdstring

createdAt*string

Request

JavaScriptCurlPython

const response = await fetch('https://indexer-dev.saturnbtc.io/v0/collection/ids?ids=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "name": "text",
    "displayName": "text",
    "symbol": "text",
    "tradeable": false,
    "verified": false,
    "icon": "text",
    "priority": 0,
    "divisibility": 0,
    "supply": "text",
    "batchSize": "text",
    "transactionId": "text",
    "createdAt": "text"
  }
]

Get Collections by Names

Retrieves multiple collections by their names.

GEThttps://indexer-dev.saturnbtc.io/v0/collection/names

Query parameters

Response

200

An array of collections matching the provided names.

Body

application/json

id*string

name*string

displayName*string

symbol*string

tradeable*boolean

verified*boolean

icon*string

priority*number

type*one of

anyanyany

divisibility*number

supply*string

batchSize*string

transactionIdstring

createdAt*string

Request

JavaScriptCurlPython

const response = await fetch('https://indexer-dev.saturnbtc.io/v0/collection/names?names=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "id": "text",
    "name": "text",
    "displayName": "text",
    "symbol": "text",
    "tradeable": false,
    "verified": false,
    "icon": "text",
    "priority": 0,
    "divisibility": 0,
    "supply": "text",
    "batchSize": "text",
    "transactionId": "text",
    "createdAt": "text"
  }
]