Collections

PreviousIndexer API NextPools

Last updated 3 days ago

get

Get details for a single collection by ID

Path parameters

idstringRequired

ID of the collection

Responses

Responseone of

all ofOptional

get

GET /collection/id/{id} HTTP/1.1
Host: 127.0.0.1:3000
Accept: */*

{
  "id": "1234:5678",
  "name": "text",
  "displayName": "text",
  "symbol": null,
  "divisibility": 1,
  "batchSize": 1,
  "supply": "text",
  "createdAt": "2025-04-26T10:18:21.872Z",
  "updatedAt": "2025-04-26T10:18:21.872Z",
  "type": "btc"
}

get

Get multiple collection details by IDs

Query parameters

idsstring[]Required

Responses

get

GET /collection/ids HTTP/1.1
Host: 127.0.0.1:3000
Accept: */*

[
  {
    "id": "1234:5678",
    "name": "text",
    "displayName": "text",
    "symbol": null,
    "divisibility": 1,
    "batchSize": 1,
    "supply": "text",
    "createdAt": "2025-04-26T10:18:21.872Z",
    "updatedAt": "2025-04-26T10:18:21.872Z",
    "type": "btc"
  }
]

get

Get multiple collection that match the name query

Query parameters

namesstring[]Required

Responses

get

GET /collection/names HTTP/1.1
Host: 127.0.0.1:3000
Accept: */*

[
  {
    "id": "1234:5678",
    "name": "text",
    "displayName": "text",
    "symbol": null,
    "divisibility": 1,
    "batchSize": 1,
    "supply": "text",
    "createdAt": "2025-04-26T10:18:21.872Z",
    "updatedAt": "2025-04-26T10:18:21.872Z",
    "type": "btc"
  }
]

post

Search mintable collections using filter criteria

Body

Struct used to filter mintable collections.

namestring | nullOptional

sortarray | nullOptional

limitinteger | nullOptional

offsetinteger | nullOptional

Responses

post

POST /collection/mintable/multi-search HTTP/1.1
Host: 127.0.0.1:3000
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "name": null,
  "sort": [
    {
      "field": "id",
      "order": "ASC"
    }
  ],
  "limit": null,
  "offset": null
}

{
  "response": [
    {
      "id": "1234:5678",
      "name": "text",
      "displayName": "text",
      "symbol": null,
      "divisibility": 1,
      "batchSize": 1,
      "supply": "text",
      "createdAt": "2025-04-26T10:18:21.872Z",
      "updatedAt": "2025-04-26T10:18:21.872Z",
      "type": "btc"
    },
    {
      "mint": {
        "collection_id": "1234:5678",
        "start": null,
        "end": null,
        "mintable": true,
        "mints": "text",
        "cap": "text",
        "amount": "text"
      }
    }
  ],
  "offset": 1
}

post

Get multiple collections using filter criteria

Body

Struct used to filter collections.

namestring | nullOptional

sortarray | nullOptional

limitinteger | nullOptional

offsetinteger | nullOptional

addressstring | nullOptional

Responses

post

POST /collection/multi-search HTTP/1.1
Host: 127.0.0.1:3000
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "name": null,
  "sort": [
    {
      "field": "id",
      "order": "ASC"
    }
  ],
  "limit": null,
  "offset": null,
  "address": null
}

{
  "response": [
    {
      "id": "1234:5678",
      "name": "text",
      "displayName": "text",
      "symbol": null,
      "divisibility": 1,
      "batchSize": 1,
      "supply": "text",
      "createdAt": "2025-04-26T10:18:21.872Z",
      "updatedAt": "2025-04-26T10:18:21.872Z",
      "type": "btc"
    }
  ],
  "offset": 1
}

post

Get mintable collections by ids

Body

idsstring[]Required

Responses

post

POST /collection/mintable/id HTTP/1.1
Host: 127.0.0.1:3000
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "ids": [
    "text"
  ]
}

[
  {
    "id": "1234:5678",
    "name": "text",
    "displayName": "text",
    "symbol": null,
    "divisibility": 1,
    "batchSize": 1,
    "supply": "text",
    "createdAt": "2025-04-26T10:18:21.872Z",
    "updatedAt": "2025-04-26T10:18:21.872Z",
    "type": "btc"
  },
  {
    "mint": {
      "collection_id": "1234:5678",
      "start": null,
      "end": null,
      "mintable": true,
      "mints": "text",
      "cap": "text",
      "amount": "text"
    }
  }
]