Skip to main content

API Spec

ChainSafe Token API (1.19.2)

Download OpenAPI specification:Download

Tokens

This section lists all the APIs related to NFT tokens.

Get Project Tokens

Get all the tokens of a project

path Parameters
projectID
required
string

Project ID

query Parameters
account
string

Owner address

chainId
required
string

Chain ID

cursor
string

pagination cursor

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Collection Tokens

Get the tokens for the collection.

path Parameters
projectID
required
string

project ID

collectionID
required
string

Collection ID

query Parameters
account
string

Owner address

cursor
string

pagination cursor

Responses

Response samples

Content type
application/json
{
  • "page_number": 0,
  • "page_size": 0,
  • "total": 0,
  • "cursor": "string",
  • "tokens": [
    ]
}

Get Collection Token

Get the token for the collection.

path Parameters
projectID
required
string

project ID

collectionID
required
string

Collection ID

tokenID
required
string

Token ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "token_id": "string",
  • "chain_id": "string",
  • "project_id": "string",
  • "collection_id": "string",
  • "token_type": "string",
  • "contract_address": "string",
  • "supply": "string",
  • "uri": "string",
  • "metadata": { }
}

Get Token Owners

Get all the owners of a token

path Parameters
projectID
required
string

Project ID

collectionID
required
string

Collection ID

tokenID
required
string

Token ID

query Parameters
cursor
string

pagination cursor

Responses

Response samples

Content type
application/json
{
  • "page_number": 0,
  • "page_size": 0,
  • "total": 0,
  • "cursor": "string",
  • "owners": [
    ]
}