Tezos Tokens API
The Tokens API from Tezos — 7 operation(s) for tokens.
The Tokens API from Tezos — 7 operation(s) for tokens.
openapi: 3.0.0
info:
title: TzKT Accounts Tokens API
description: "# Introduction\r\n\r\nTzKT is the most widely used tool in Tezos that provides you with convenient and flexible access to the Tezos blockchain data, processed and indexed by its own indexer. \r\nYou can fetch all historical data via REST API, or subscribe for real-time data via WebSocket API. TzKT was built by the joint efforts of the entire Tezos community \r\nto help developers build more services and dapps on top of Tezos.\r\n\r\nTzKT Indexer and API are [open-source](https://github.com/baking-bad/tzkt), so don't be afraid to depend on the third-party service,\r\nbecause you can always clone, build and run it yourself to have full control over all the components.\r\n\r\nFeel free to contact us if you have any questions or feature requests.\r\nYour feedback is much appreciated!\r\n\r\n- Discord: https://discord.gg/aG8XKuwsQd\r\n- Telegram: https://t.me/baking_bad_chat\r\n- X: https://x.com/TezosBakingBad\r\n- Email: hello@bakingbad.dev\r\n\r\nAnd don't forget to star TzKT [on GitHub](https://github.com/baking-bad/tzkt) if you like it \U0001F60A\r\n\r\n# Get Started\r\n\r\nThere are two API services provided for public use:\r\n- **Free TzKT API** with free anonymous access;\r\n- **TzKT Pro** with paid subscriptions with increased rate limits, off-chain data, extended support and business-level SLA.\r\n\r\nYou can find more details about differences between available tiers [here](https://tzkt.io/api).\r\n\r\n## Free TzKT API\r\n\r\nFree-tier TzKT API is the best way to get started and explore available Tezos data and API functionality.\r\nIt doesn't require authorization and is free for everyone and for both commercial and non-commercial use.\r\n\r\n> #### Note: attribution required\r\nIf you use free-tier TzKT API, you **must** mention it on your website or application by placing the label\r\n\"Powered by TzKT API\", or \"Built with TzKT API\", or \"Data provided by TzKT API\" with a direct link to [tzkt.io](https://tzkt.io).\r\n\r\nIt's available for the following Tezos networks with the following base URLs:\r\n\r\n- Mainnet: `https://api.tzkt.io/` or `https://api.mainnet.tzkt.io/` ([view docs](https://api.tzkt.io))\r\n- Ghostnet: `https://api.ghostnet.tzkt.io/` ([view docs](https://api.ghostnet.tzkt.io))\r\n- Shadownet: `https://api.shadownet.tzkt.io/` ([view docs](https://api.shadownet.tzkt.io))\r\n- Seoulnet: `https://api.seoulnet.tzkt.io/` ([view docs](https://api.seoulnet.tzkt.io))\r\n- Tallinnnet: `https://api.tallinnnet.tzkt.io/` ([view docs](https://api.tallinnnet.tzkt.io))\r\n\r\n### Sending Requests\r\n\r\nTo send a request to Free TzKT API you need literally nothing. Just take the base URL of the particular network\r\n(for example, Tezos mainnet: `https://api.tzkt.io`) and append the path of the particular endpoint\r\n(for example, chain's head: `/v1/head`), that's pretty much it: \r\n\r\n```bash\r\ncurl https://api.tzkt.io/v1/head\r\n```\r\n\r\nRead through this documentation to explore available endpoints, query parameters\r\n(note, if you click on a query parameter, you will see available modes, such as `.eq`, `.in`, etc.)\r\nand response models. If you have any questions, do not hesitate to ask for support, Tezos community has always been very friendly! \U0001F609\r\n\r\n### Rate Limits\r\n\r\nPlease, refer to https://tzkt.io/api to check relevant rate limits.\r\n\r\nIf you exceed the limit, the API will respond with `HTTP 429` status code.\r\n\r\n## TzKT Pro\r\n\r\nTzKT Pro is intended for professional use, for those who seek for extended capabilities, performance, reliability and business-level SLA.\r\nTzKT Pro service is provided via paid subscriptions. Please, refer to [Pricing Plans](https://tzkt.io/api) to check available tiers.\r\n\r\nIt's available for the following Tezos networks with the following base URLs:\r\n\r\n- Mainnet: `https://pro.tzkt.io/` ([view docs](https://api.tzkt.io))\r\n- Testnets: *let us know if you need TzKT Pro for testnets*\r\n\r\n### Authorization\r\n\r\nTo access TzKT Pro you will need to authorize requests with your personal API key, that you will receive on your email after purchasing a subscription.\r\nThis can be done by adding the query string parameter `?apikey={your_key}` or by adding the HTTP header `apikey: {your_key}`.\r\n\r\nNote that you can have multiple API keys within a single subscription.\r\n\r\nKeep your API keys private, do not publish it anywhere and do not hardcode it, especially in public repositories.\r\nIf your key was compromised, just let us know and we will issue a new one.\r\n\r\nAlso note that passing the API key via HTTP headers is more secure, because in HTTPS headers are encrypted,\r\nbut query string is not, so the key can be unintentionally exposed to third parties.\r\n\r\n### Sending Requests\r\n\r\nSending a request with the API key passed as a query string parameter:\r\n\r\n```bash\r\ncurl https://pro.tzkt.io/v1/head?apikey={your_key}\r\n```\r\n\r\nSending a request with the API key passed via an HTTP header:\r\n\r\n```bash\r\ncurl https://pro.tzkt.io/v1/head \\\r\n -H 'apikey: {your_key}'\r\n```\r\n\r\n### Rate Limits\r\n\r\nPlease, refer to https://tzkt.io/api to check relevant rate limits for different pricing plans.\r\n\r\nAlso, TzKT Pro provides you with the additional HTTP headers to show the allowed limits, number of available requests\r\nand the time remaining (in seconds) until the quota is reset. Here's an example:\r\n\r\n```\r\nRateLimit-Limit: 50\r\nRateLimit-Remaining: 49\r\nRateLimit-Reset: 1\r\n```\r\n\r\nIt also sends general information about your rate limits per second and per day:\r\n\r\n```\r\nX-RateLimit-Limit-Second: 50\r\nX-RateLimit-Remaining-Second: 49\r\nX-RateLimit-Limit-Day: 3000000\r\nX-RateLimit-Remaining-Day: 2994953\r\n```\r\n\r\nIf you exceed the limit, the API will respond with `HTTP 429` status code.\r\n"
contact:
name: Baking Bad Team
url: https://bakingbad.dev
email: hello@bakingbad.dev
version: 1.17.1
x-logo:
url: https://tzkt.io/logo.png
href: https://tzkt.io/
servers:
- url: https://api.tzkt.io
tags:
- name: Tokens
paths:
/v1/tokens/count:
get:
tags:
- Tokens
summary: Get tokens count
description: Returns a total number of tokens.
operationId: Tokens_GetTokensCount
parameters:
- name: id
in: query
description: "Filter by internal TzKT id. Note, this is not the same as `tokenId` nat value. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/Int64Parameter'
x-position: 1
x-tzkt-extension: query-parameter
- name: contract
in: query
description: "Filter by contract address. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/AccountParameter'
x-position: 2
x-tzkt-extension: query-parameter
- name: tokenId
in: query
description: "Filter by tokenId (for FA1.2 tokens tokenId is always `\"0\"`). \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/NatParameter'
x-position: 3
x-tzkt-extension: query-parameter
- name: globalId
in: query
description: "Filter by \"global id\", which is a `\"{contract}:{tokenId}\"` string. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/TokenGlobalIdParameter'
x-position: 4
- name: standard
in: query
description: "Filter by token standard (`fa1.2` or `fa2`). \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/TokenStandardParameter'
x-position: 5
x-tzkt-extension: query-parameter
x-tzkt-query-parameter: fa1.2,fa2
- name: totalMinted
in: query
description: "Filter by total minted. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/NatParameter'
x-position: 6
x-tzkt-extension: query-parameter
- name: totalBurned
in: query
description: "Filter by total burned. Note: total burned shows only those tokens that were literally burned,\nexcluding tokens sent to burn addresses (because they still exist on the burn address' balance). \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/NatParameter'
x-position: 7
x-tzkt-extension: query-parameter
- name: totalSupply
in: query
description: "Filter by total supply. Note: total supply shows all existing tokens,\nincluding tokens sent to burn addresses (so that they exist on the burn address' balance). \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/NatParameter'
x-position: 8
x-tzkt-extension: query-parameter
- name: firstMinter
in: query
description: "Filter by address of the first minter. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/AccountParameter'
x-position: 9
x-tzkt-extension: query-parameter
- name: firstLevel
in: query
description: "Filter by level of the block where the token was first seen. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/Int32Parameter'
x-position: 10
x-tzkt-extension: query-parameter
- name: firstTime
in: query
description: "Filter by timestamp (ISO 8601) of the block where the token was first seen. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/TimestampParameter'
x-position: 11
x-tzkt-extension: query-parameter
- name: lastLevel
in: query
description: "Filter by level of the block where the token was last seen. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/Int32Parameter'
x-position: 12
x-tzkt-extension: query-parameter
- name: lastTime
in: query
description: "Filter by timestamp (ISO 8601) of the block where the token was last seen. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/TimestampParameter'
x-position: 13
x-tzkt-extension: query-parameter
- name: metadata
in: query
description: "Filter by metadata. \nNote, this parameter supports the following format: `metadata{.path?}{.mode?}=...`,\nso you can specify a path to a particular field to filter by (for example, `?metadata.symbol.in=kUSD,uUSD`). \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/JsonParameter'
x-position: 14
x-tzkt-extension: json-parameter
- name: indexedAt
in: query
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/Int32NullParameter'
x-position: 15
x-tzkt-extension: query-parameter
responses:
'200':
description: ''
content:
application/json:
schema:
type: integer
format: int32
/v1/tokens:
get:
tags:
- Tokens
summary: Get tokens
description: Returns a list of tokens.
operationId: Tokens_GetTokens
parameters:
- name: id
in: query
description: "Filter by internal TzKT id. Note, this is not the same as `tokenId` nat value. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/Int64Parameter'
x-position: 1
x-tzkt-extension: query-parameter
- name: contract
in: query
description: "Filter by contract address. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/AccountParameter'
x-position: 2
x-tzkt-extension: query-parameter
- name: tokenId
in: query
description: "Filter by tokenId (for FA1.2 tokens tokenId is always `\"0\"`). \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/NatParameter'
x-position: 3
x-tzkt-extension: query-parameter
- name: globalId
in: query
description: "Filter by \"global id\", which is a `\"{contract}:{tokenId}\"` string. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/TokenGlobalIdParameter'
x-position: 4
- name: standard
in: query
description: "Filter by token standard (`fa1.2` or `fa2`). \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/TokenStandardParameter'
x-position: 5
x-tzkt-extension: query-parameter
x-tzkt-query-parameter: fa1.2,fa2
- name: totalMinted
in: query
description: "Filter by total minted. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/NatParameter'
x-position: 6
x-tzkt-extension: query-parameter
- name: totalBurned
in: query
description: "Filter by total burned. Note: total burned shows only those tokens that were literally burned,\nexcluding tokens sent to burn addresses (because they still exist on the burn address' balance). \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/NatParameter'
x-position: 7
x-tzkt-extension: query-parameter
- name: totalSupply
in: query
description: "Filter by total supply. Note: total supply shows all existing tokens,\nincluding tokens sent to burn addresses (so that they exist on the burn address' balance). \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/NatParameter'
x-position: 8
x-tzkt-extension: query-parameter
- name: firstMinter
in: query
description: "Filter by address of the first minter. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/AccountParameter'
x-position: 9
x-tzkt-extension: query-parameter
- name: firstLevel
in: query
description: "Filter by level of the block where the token was first seen. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/Int32Parameter'
x-position: 10
x-tzkt-extension: query-parameter
- name: firstTime
in: query
description: "Filter by timestamp (ISO 8601) of the block where the token was first seen. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/TimestampParameter'
x-position: 11
x-tzkt-extension: query-parameter
- name: lastLevel
in: query
description: "Filter by level of the block where the token was last seen. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/Int32Parameter'
x-position: 12
x-tzkt-extension: query-parameter
- name: lastTime
in: query
description: "Filter by timestamp (ISO 8601) of the block where the token was last seen. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/TimestampParameter'
x-position: 13
x-tzkt-extension: query-parameter
- name: metadata
in: query
description: "Filter by metadata. \nNote, this parameter supports the following format: `metadata{.path?}{.mode?}=...`,\nso you can specify a path to a particular field to filter by (for example, `?metadata.symbol.in=kUSD,uUSD`). \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/JsonParameter'
x-position: 14
x-tzkt-extension: json-parameter
- name: indexedAt
in: query
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/Int32NullParameter'
x-position: 15
x-tzkt-extension: query-parameter
- name: sort
in: query
description: "Sorts items (asc or desc) by the specified field.\nYou can see what fields can be used for sorting in the response description, below. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/SortParameter'
x-position: 16
x-tzkt-extension: query-parameter
- name: offset
in: query
description: "Specifies which or how many items should be skipped. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/OffsetParameter'
x-position: 17
x-tzkt-extension: query-parameter
- name: limit
in: query
description: Maximum number of items to return.
schema:
type: integer
format: int32
maximum: 10000.0
minimum: 0.0
x-position: 18
- name: select
in: query
description: "Specify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.\nThis parameter accepts values of the following format: `{field}{path?}{as alias?}`, so you can do deep selection\n(for example, `?select=balance,token.metadata.symbol as token,...`). \nNote, if you select just one field, the response will be flatten into a simple array of values. \nClick on the parameter to expand the details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/SelectionParameter'
x-position: 19
x-tzkt-extension: query-parameter
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Token'
/v1/tokens/balances/count:
get:
tags:
- Tokens
summary: Get token balances count
description: Returns a total number of token balances.
operationId: Tokens_GetTokenBalancesCount
parameters:
- name: id
in: query
description: "Filter by internal TzKT id. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/Int64Parameter'
x-position: 1
x-tzkt-extension: query-parameter
- name: account
in: query
description: "Filter by account address. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/AccountParameter'
x-position: 2
x-tzkt-extension: query-parameter
- name: token.id
in: query
description: "Filter by internal TzKT id. Note, this is not the same as `tokenId`. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/Int64Parameter'
x-position: 3
x-tzkt-extension: query-parameter
- name: token.contract
in: query
description: "Filter by contract address. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/AccountParameter'
x-position: 4
x-tzkt-extension: query-parameter
- name: token.tokenId
in: query
description: "Filter by tokenId (for FA1.2 tokens tokenId is always `\"0\"`). \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/NatParameter'
x-position: 5
x-tzkt-extension: query-parameter
- name: token.standard
in: query
description: "Filter by token standard (`fa1.2` or `fa2`). \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/TokenStandardParameter'
x-position: 6
x-tzkt-extension: query-parameter
x-tzkt-query-parameter: fa1.2,fa2
- name: token.metadata
in: query
description: "Filter by metadata. Note, this parameter supports the following format: `token.metadata{.path?}{.mode?}=...`,\nso you can specify a path to a particular field to filter by, for example: `?token.metadata.symbol.in=kUSD,uUSD`. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/JsonParameter'
x-position: 7
x-tzkt-extension: json-parameter
- name: balance
in: query
description: "Filter by balance. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/NatParameter'
x-position: 8
x-tzkt-extension: query-parameter
- name: firstLevel
in: query
description: "Filter by level of the block where the balance was first changed. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/Int32Parameter'
x-position: 9
x-tzkt-extension: query-parameter
- name: firstTime
in: query
description: "Filter by timestamp (ISO 8601) of the block where the balance was first changed. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/TimestampParameter'
x-position: 10
x-tzkt-extension: query-parameter
- name: lastLevel
in: query
description: "Filter by level of the block where the balance was last seen. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/Int32Parameter'
x-position: 11
x-tzkt-extension: query-parameter
- name: lastTime
in: query
description: "Filter by timestamp (ISO 8601) of the block where the balance was last changed. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/TimestampParameter'
x-position: 12
x-tzkt-extension: query-parameter
- name: indexedAt
in: query
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/Int32NullParameter'
x-position: 13
x-tzkt-extension: query-parameter
responses:
'200':
description: ''
content:
application/json:
schema:
type: integer
format: int32
/v1/tokens/balances:
get:
tags:
- Tokens
summary: Get token balances
description: Returns a list of token balances.
operationId: Tokens_GetTokenBalances
parameters:
- name: id
in: query
description: "Filter by internal TzKT id. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/Int64Parameter'
x-position: 1
x-tzkt-extension: query-parameter
- name: account
in: query
description: "Filter by account address. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/AccountParameter'
x-position: 2
x-tzkt-extension: query-parameter
- name: token.id
in: query
description: "Filter by internal TzKT id. Note, this is not the same as `tokenId`. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/Int64Parameter'
x-position: 3
x-tzkt-extension: query-parameter
- name: token.contract
in: query
description: "Filter by contract address. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/AccountParameter'
x-position: 4
x-tzkt-extension: query-parameter
- name: token.tokenId
in: query
description: "Filter by tokenId (for FA1.2 tokens tokenId is always `\"0\"`). \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/NatParameter'
x-position: 5
x-tzkt-extension: query-parameter
- name: token.standard
in: query
description: "Filter by token standard (`fa1.2` or `fa2`). \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/TokenStandardParameter'
x-position: 6
x-tzkt-extension: query-parameter
x-tzkt-query-parameter: fa1.2,fa2
- name: token.metadata
in: query
description: "Filter by metadata. Note, this parameter supports the following format: `token.metadata{.path?}{.mode?}=...`,\nso you can specify a path to a particular field to filter by, for example: `?token.metadata.symbol.in=kUSD,uUSD`. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/JsonParameter'
x-position: 7
x-tzkt-extension: json-parameter
- name: balance
in: query
description: "Filter by balance. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/NatParameter'
x-position: 8
x-tzkt-extension: query-parameter
- name: firstLevel
in: query
description: "Filter by level of the block where the balance was first changed. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/Int32Parameter'
x-position: 9
x-tzkt-extension: query-parameter
- name: firstTime
in: query
description: "Filter by timestamp (ISO 8601) of the block where the balance was first changed. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/TimestampParameter'
x-position: 10
x-tzkt-extension: query-parameter
- name: lastLevel
in: query
description: "Filter by level of the block where the balance was last seen. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/Int32Parameter'
x-position: 11
x-tzkt-extension: query-parameter
- name: lastTime
in: query
description: "Filter by timestamp (ISO 8601) of the block where the balance was last changed. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/TimestampParameter'
x-position: 12
x-tzkt-extension: query-parameter
- name: indexedAt
in: query
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/Int32NullParameter'
x-position: 13
x-tzkt-extension: query-parameter
- name: sort
in: query
description: "Sorts items (asc or desc) by the specified field.\nYou can see what fields can be used for sorting in the response description, below. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/SortParameter'
x-position: 14
x-tzkt-extension: query-parameter
- name: offset
in: query
description: "Specifies which or how many items should be skipped. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/OffsetParameter'
x-position: 15
x-tzkt-extension: query-parameter
- name: limit
in: query
description: Maximum number of items to return.
schema:
type: integer
format: int32
maximum: 10000.0
minimum: 0.0
x-position: 16
- name: select
in: query
description: "Specify a comma-separated list of fields to include into response or leave it undefined to get default set of fields.\nThis parameter accepts values of the following format: `{field}{path?}{as alias?}`, so you can do deep selection\n(for example, `?select=balance,token.metadata.symbol as token,...`). \nNote, if you select just one field, the response will be flatten into a simple array of values. \nClick on the parameter to expand the details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/SelectionParameter'
x-position: 17
x-tzkt-extension: query-parameter
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TokenBalance'
/v1/tokens/transfers/count:
get:
tags:
- Tokens
summary: Get token transfers count
description: Returns the total number of token transfers.
operationId: Tokens_GetTokenTransfersCount
parameters:
- name: id
in: query
description: "Filter by internal TzKT id. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/Int64Parameter'
x-position: 1
x-tzkt-extension: query-parameter
- name: level
in: query
description: "Filter by level of the block where the transfer was made. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/Int32Parameter'
x-position: 2
x-tzkt-extension: query-parameter
- name: timestamp
in: query
description: "Filter by timestamp (ISO 8601) of the block where the transfer was made. \nClick on the parameter to expand more details."
schema:
nullable: true
oneOf:
- $ref: '#/components/schemas/TimestampParameter'
x-position: 3
x-tzkt-extension: query-parameter
# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tezos/refs/heads/main/openapi/tezos-tokens-api-openapi.yml