tapAPI (1.0.0)

Download OpenAPI specification:Download

tapAPI provides instant access to the Tap Protocol ecosystem.

You can access the API without an API Key while we are launching it. We will change that soon and document how to obtain the API Keys here.

Tokens

Calls to retrieve data for tokens on the TAP Protocol. This includes standard TAP and DMT (Digital Matter Theory) tokens (i.e. dmt-nat).

/v1/tokens

Get all Token Deployments

This endpoint makes an HTTP GET request to retrieve a paginated list of all token deployments.

The query parameters include 'limit' to specify the maximum number of tokens to be returned and 'offset' to specify the starting position for the list.

query Parameters
limit
integer
Example: limit=100
offset
integer
Example: offset=0

Responses

/v1/tokens/:tick

Get specific Token Deployment

This endpoint makes an HTTP GET request to retrieve a specific token deployment identified by the tick.

path Parameters
tick
required
string
Example: tap

(Required)

Responses

/v1/tokens/:tick/mints

Get Token Mints

This endpoint makes an HTTP GET request to retrieve a paginated list of token mints for a specified tick.

The query parameters include 'limit' to specify the maximum number of tokens to be returned and 'offset' to specify the starting position for the list.

path Parameters
tick
required
string
Example: tap

(Required)

query Parameters
limit
integer
Example: limit=100
offset
integer
Example: offset=0

Responses

/v1/tokens/:tick/holders

Get Token Holders

This endpoint makes an HTTP GET request to retrieve a paginated list of holders for a specific token, identified by the tick.

The query parameters include 'limit' to specify the maximum number of tokens to be returned and 'offset' to specify the starting position for the list.

path Parameters
tick
required
string
Example: tap

(Required)

query Parameters
limit
integer
Example: limit=100
offset
integer
Example: offset=0

Responses

/v1/tokens/:tick/transfers

Get Token Transfers

This endpoint makes an HTTP GET request to retrieve a paginated list of token transfers for a specified tick.

The query parameters include 'limit' to specify the maximum number of tokens to be returned and 'offset' to specify the starting position for the list.

path Parameters
tick
required
string
Example: tap

(Required)

query Parameters
limit
integer
Example: limit=100
offset
integer
Example: offset=0

Responses

UNAT Collections

UNATs or (Unique Non-Arbitrary Tokens) are hybrid tokens for all TAP token tickers starting with "dmt-" i.e. dmt-natcats. While all dmt-ticks have a fungible token associated (Non-Arbitrary Token, NAT) and these token info can be retrieved with the Token calls (see above).

The following calls can retrieve the non-fungible (UNAT collection) information.

/v1/unats

Get all UNAT Collection Deployments

This endpoint makes an HTTP GET request to retrieve a paginated list of all UNAT collection deployments.

The query parameters include 'limit' to specify the maximum number of tokens to be returned and 'offset' to specify the starting position for the list.

query Parameters
limit
integer
Example: limit=100
offset
integer
Example: offset=0

Responses

/v1/unats/:tick

Get UNATs in Collection

This endpoint makes an HTTP GET request to retrieve a paginated list of all UNATs in a collection identified by the tick.

path Parameters
tick
required
string
Example: dmt-natbat

(Required)

query Parameters
limit
integer
Example: limit=100
offset
integer
Example: offset=0

Responses

/v1/unats/:tick/holders

Get UNAT Collection Holders

This endpoint makes an HTTP GET request to retrieve a paginated list of holders for a specific UNAT collection identified by the tick.

The query parameters include 'limit' to specify the maximum number of tokens to be returned and 'offset' to specify the starting position for the list.

path Parameters
tick
required
string
Example: dmt-hiros

(Required)

query Parameters
limit
integer
Example: limit=100
offset
integer
Example: offset=0

Responses

v1/unats/:tick/mints

Get Token Mints

This endpoint makes an HTTP GET request to retrieve a paginated list of mints for a specific UNAT Collection identified by the tick.

The query parameters include 'limit' to specify the maximum number of tokens to be returned and 'offset' to specify the starting position for the list.

path Parameters
tick
required
string
Example: dmt-natbat

(Required)

query Parameters
limit
integer
Example: limit=100
offset
integer
Example: offset=0

Responses

Addresses

Calls to retrieve token and collection data for tokens in specific wallets.

/v1/addresses/:address/tokens

Get Tokens for Address

This endpoint makes an HTTP GET request to retrieve a paginated list of all tokens owned by an address, including the token deployment details.

The query parameters include 'limit' to specify the maximum number of tokens to be returned and 'offset' to specify the starting position for the list.

path Parameters
address
required
string
Example: bc1pcw6s2w5svwdwgd6x0welkktymds3cz54lvgplnqcpta26mr20hdsuxam52

(Required)

query Parameters
limit
integer
Example: limit=100
offset
integer
Example: offset=0

0

Responses

/v1/addresses/:address/tokens/sent

Get sent Tokens for Address

This endpoint makes an HTTP GET request to retrieve a paginated list of all tokens sent by an address, including the token deployment details.

The query parameters include 'limit' to specify the maximum number of tokens to be returned and 'offset' to specify the starting position for the list.

path Parameters
address
required
string
Example: bc1pcw6s2w5svwdwgd6x0welkktymds3cz54lvgplnqcpta26mr20hdsuxam52

(Required)

query Parameters
limit
integer
Example: limit=100
offset
integer
Example: offset=0

Responses

/v1/addresses/:address/tokens/received

Get sent Tokens for Address

This endpoint makes an HTTP GET request to retrieve a paginated list of all tokens received by an address, including the token deployment details.

The query parameters include 'limit' to specify the maximum number of tokens to be returned and 'offset' to specify the starting position for the list.

path Parameters
address
required
string
Example: bc1pcw6s2w5svwdwgd6x0welkktymds3cz54lvgplnqcpta26mr20hdsuxam52

(Required)

query Parameters
limit
integer
Example: limit=100
offset
integer
Example: offset=0

Responses

/v1/addresses/:address/tokens/minted

Get sent Tokens for Address

This endpoint makes an HTTP GET request to retrieve a paginated list of all tokens minted by an address, including the token deployment details.

The query parameters include 'limit' to specify the maximum number of tokens to be returned and 'offset' to specify the starting position for the list.

path Parameters
address
required
string
Example: bc1pcw6s2w5svwdwgd6x0welkktymds3cz54lvgplnqcpta26mr20hdsuxam52

(Required)

query Parameters
limit
integer
Example: limit=100
offset
integer
Example: offset=0

Responses

/v1/addresses/:address/unats

Get UNATs for Address

This endpoint makes an HTTP GET request to retrieve a paginated list of all UNATs owned by an address.

The query parameters include 'limit' to specify the maximum number of tokens to be returned and 'offset' to specify the starting position for the list.

path Parameters
address
required
string
Example: bc1pcw6s2w5svwdwgd6x0welkktymds3cz54lvgplnqcpta26mr20hdsuxam52

(Required)

query Parameters
limit
integer
Example: limit=100
offset
integer
Example: offset=0

Responses