Ctrlk
Launch App
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Collections

post

Search mintable collections using filter criteria

Body

Struct used to filter mintable collections.

namestring · nullableOptional
limitinteger · nullableOptional
offsetinteger · nullableOptional
Responses
200

Paginated collections

application/json
offsetinteger · int32Required
post/collection/mintable/multi-search
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": "text",
      "name": "text",
      "displayName": "text",
      "symbol": null,
      "divisibility": 1,
      "supply": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "type": "btc"
    },
    {
      "mint": {
        "collection_id": "text",
        "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 · nullableOptional
limitinteger · nullableOptional
offsetinteger · nullableOptional
addressstring · nullableOptional
Responses
200

Paginated collections

application/json
offsetinteger · int32Required
post/collection/multi-search
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": "text",
      "name": "text",
      "displayName": "text",
      "symbol": null,
      "divisibility": 1,
      "supply": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "type": "btc"
    }
  ],
  "offset": 1
}
post

Get mintable collections by ids

Body
idsstring[]Required
Responses
200

List of mintable collections

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

{
  "ids": [
    "text"
  ]
}
[
  {
    "id": "text",
    "name": "text",
    "displayName": "text",
    "symbol": null,
    "divisibility": 1,
    "supply": "text",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "type": "btc"
  },
  {
    "mint": {
      "collection_id": "text",
      "start": null,
      "end": null,
      "mintable": true,
      "mints": "text",
      "cap": "text",
      "amount": "text"
    }
  }
]
get

Get details for a single collection by ID

Path parameters
idstringRequired

ID of the collection

Responses
200

Collection

application/json
or
get/collection/id/{id}
GET /collection/id/{id} HTTP/1.1
Host: 127.0.0.1:3000
Accept: */*

{
  "id": "text",
  "name": "text",
  "displayName": "text",
  "symbol": null,
  "divisibility": 1,
  "supply": "text",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "type": "btc"
}
get

Get multiple collection details by IDs

Query parameters
idsstring[]Required
Responses
200

List of collections

application/json
or
get/collection/ids
GET /collection/ids?ids=text HTTP/1.1
Host: 127.0.0.1:3000
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "displayName": "text",
    "symbol": null,
    "divisibility": 1,
    "supply": "text",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "type": "btc"
  }
]
get

Get multiple collection that match the name query

Query parameters
namesstring[]Required
Responses
200

List of collections

application/json
or
get/collection/names
GET /collection/names?names=text HTTP/1.1
Host: 127.0.0.1:3000
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "displayName": "text",
    "symbol": null,
    "divisibility": 1,
    "supply": "text",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "type": "btc"
  }
]

PreviousIndexer API
NextPools

Last updated