Skip to content

token.md

Latest commit

 

History

History
210 lines (159 loc) · 17.4 KB

token.md

File metadata and controls

210 lines (159 loc) · 17.4 KB

Token API Banner

Welcome to the Token API

The Token API provides endpoints for retrieving any token, token balance, transfer, and symbol in existence, including full support for native token transfers and balances (fully supports both ERC-20 and ERC-777 tokens).

Endpoint Overview

The Token API supports the following groups of endpoints:

  1. Token Endpoints: Retrieve any token ever created using flexible queries, along with token metadata and symbols.
  2. Owner Endpoints: Retrieve all owners and owner balances for a token (ordered by balance).
  3. Transfer Endpoints: Retrieve all transfers, including mints, sends, and burns, for any token or individual account.
  4. Swap Endpoints: Retrieve all swaps for any token, account, or date range across all decentralized exchanges.
  5. Native Token Endpoints: Retrieve all native token transfers and balances for any account.

Endpoint Specifications

Token Endpoints

SDK Method Endpoint URL Returns
token.tokens_by_date_created(created_after, created_before, standard, order, limit) GET /v0/token/tokens-by-date-created List[Token]
token.tokens_by_contract_address(contract_address, created_after, created_before, standard, order, limit) GET /v0/token/tokens-by-contract-address List[Token]
token.tokens_by_name(name, limit, fuzzy) GET /v0/token/tokens-by-name List[Token]
token.tokens_by_symbol(symbol, limit, fuzzy) GET /v0/token/tokens-by-symbol List[Token]
token.tokens_by_owner(owner_address, contract_address, limit) GET /v0/token/tokens-by-owner List[TokenWithOwner]

Token Model

View Model Specification

The Token Model represents a single NFT token. The Token Model follows the following structure:

Name Description Type
contract_address Contract address of the token string
name Name of the token string
symbol Symbol of the token string
decimals The number of decimals used by the token in user representations. integer
created_timestamp The token's timestamp of creation (in ISO-8601 format). date-time
standard The standard of the token (ERC-20 or ERC-777). string
supply The token's total supply (tokens minted minus tokens burned). integer
external_url The token's website URL. string
image_url The token's icon image URL. string
twitter_username The token's Twitter username. string
telegram_url The token's Telegram URL. string
discord_url The token's Discord URL. string
whitepaper_url The token's whitepaper URL. string
last_refreshed The timestamp at which the token was last refreshed by the Transpose backend (in ISO-8601 format). date-time

Token With Owner Model

View Model Specification

The Token With Owner Model represents a single token with included ownership data (i.e. the owner account and owner's balance). The Token With Owner Model follows the following structure:

Name Description Type
contract_address Contract address of the token string
name Name of the token string
symbol Symbol of the token string
decimals The number of decimals used by the token in user representations. integer
created_timestamp The token's timestamp of creation (in ISO-8601 format). date-time
standard The standard of the token (ERC-20 or ERC-777). string
supply The token's total supply (tokens minted minus tokens burned). integer
external_url The token's website URL. string
image_url The token's icon image URL. string
twitter_username The token's Twitter username. string
telegram_url The token's Telegram URL. string
discord_url The token's Discord URL. string
whitepaper_url The token's whitepaper URL. string
last_refreshed The timestamp at which the token was last refreshed by the Transpose backend (in ISO-8601 format). date-time
owner The owner's account address. string
balance The owner's balance of the token. integer

Owner Endpoints

SDK Method Endpoint URL Returns
token.owners_by_contract_address(contract_address, limit) GET /v0/token/owners-by-contract-address List[TokenOwner]

Token Owner Model

View Model Specification

The Token Owner Model represents a single token owner. The Token Owner Model follows the following structure:

Name Description Type
contract_address Contract address of the token. string
owner The address of the owner. string
balance The owner's balance for the token. integer

Transfer Endpoints

SDK Method Endpoint URL Returns
token.transfers(transferred_after, transferred_before, order, limit) GET /v0/token/transfers List[TokenTransfer]
token.transfers_by_contract_address(contract_address, transferred_after, transferred_before, order, limit) GET /v0/token/transfers-by-contract-address List[TokenTransfer]
token.transfers_by_account(account_address, transferred_after, transferred_before, order, limit) GET /v0/token/transfers-by-account List[TokenTransfer]

Token Transfer Model

View Model Specification

The Token Transfer Model represents a single token transfer. The Token Transfer Model follows the following structure:

Name Description Type
contract_address Contract address of the token. string
block_number The block number at which the transfer occurred. integer
log_index The log index at which the transfer occurred. integer
transaction_hash The transaction hash at which the transfer occurred. string
timestamp The timestamp of the transfer (in ISO-8601 format). date-time
category The category of the ENS name transfer (one of mint, send, burn). string
operator The address of the operator that performed the transfer. string
from The address of the sender. string
to The address of the receiver. string
quantity The quantity of tokens transferred. integer

Swap Endpoints

SDK Method Endpoint URL Returns
token.swaps(occurred_after, occurred_before, order, limit) GET /v0/token/swaps List[Swap]
token.swaps_by_account(account_address, occurred_after, occurred_before, order, limit) GET /v0/token/swaps-by-account List[Swap]
token.swaps_by_contract_address(token_address, direction, occurred_after, occurred_before, order, limit) GET /v0/token/swaps-by-token List[Swap]
token.swaps_by_pair(token_one, token_two occurred_after, occurred_before, order, limit) GET /v0/token/swaps-by-pair List[Swap]

Token Swap Model

View Model Specification

The Token Swap Model represents a single token swap. The Token Swap Model follows the following structure:

Name Description Type
pair_contract_address Contract address of the token pair, if applicable. string
from_token Contract address of the token swapped from. string
to_token Contract address of the token swapped to. string
block_number The block number at which the swap occurred. integer
log_index The log index at which the swap occurred. integer
transaction_hash The transaction hash at which the swap occurred. string
timestamp The timestamp of the swap (in ISO-8601 format). date-time
exchange_name The name of the exchange that hosted the token swap. string
contract_version The version of the exchange contract that hosted the token swap. string
quantity_in The amount of tokens the swapper put into the swap. integer
quantity_out The amount of tokens that the swapper received from the swap integer
effective_price The effective price of to_token denominated in from_token (quantity_out / quantity_in). number
sender The address of the sender (may be a router contract address). string
origin The address of the originator of the swap transaction. string

Native Token Endpoints

SDK Method Endpoint URL Returns
token.native_token_transfers(transferred_after, transferred_before, order, limit) GET /v0/token/native-token-transfers List[NativeTokenTransfer]
token.native_token_transfers_by_account(account_address, transferred_after, transferred_before, order, limit) GET /v0/token/native-token-transfers-by-account List[NativeTokenTransfer]
token.native_token_balances_by_account(account_addresses) GET /v0/token/native-token-balances-by-account List[NativeTokenBalance]

Native Token Transfer Model

View Model Specification

The Native Token Transfer Model represents a single native token transfer. The Native Token Transfer Model follows the following structure:

Name Description Type
block_number The block number at which the transfer occurred. integer
activity_id A sequential ID to identify the correct ordering of native token transfers. integer
transaction_hash The transaction hash at which the transfer occurred. string
timestamp The timestamp of the transfer (in ISO-8601 format). date-time
category The category of the ENS name transfer (one of mint, send, burn). string
operator The address of the operator that performed the transfer. string
from The address of the sender. string
to The address of the receiver. string
quantity The quantity of tokens transferred. integer

Native Token Balance Model

View Model Specification

The Native Token Balance Model represents an account's native token (Ether) balance. The Native Token Balance Model follows the following structure:

Name Description Type
account_address The account address. string
balance The account's native token balance. integer