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 - 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: 4 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: 5 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: 6 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: 7 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: 8 x-tzkt-extension: json-parameter - name: anyof in: query description: "Filter by any of the specified fields (`from` or `to`).\nExample: `anyof.from.to=tz1...` will return transfers where `from` OR `to` is equal to the specified value.\nThis parameter is useful when you need to get both incoming and outgoing transfers of the account at once. \nClick on the parameter to expand more details." schema: nullable: true oneOf: - $ref: '#/components/schemas/AnyOfParameter' x-position: 9 x-tzkt-extension: anyof-parameter x-tzkt-anyof-parameter: from,to - name: from in: query description: "Filter by sender account address. \nClick on the parameter to expand more details." schema: nullable: true oneOf: - $ref: '#/components/schemas/AccountParameter' x-position: 10 x-tzkt-extension: query-parameter - name: to in: query description: "Filter by target account address. \nClick on the parameter to expand more details." schema: nullable: true oneOf: - $ref: '#/components/schemas/AccountParameter' x-position: 11 x-tzkt-extension: query-parameter - name: amount in: query description: "Filter by amount. \nClick on the parameter to expand more details." schema: nullable: true oneOf: - $ref: '#/components/schemas/NatParameter' x-position: 12 x-tzkt-extension: query-parameter - name: transactionId in: query description: "Filter by id of the transaction, caused the token transfer. \nClick on the parameter to expand more details." schema: nullable: true oneOf: - $ref: '#/components/schemas/Int64NullParameter' x-position: 13 x-tzkt-extension: query-parameter - name: originationId in: query description: "Filter by id of the origination, caused the token transfer. \nClick on the parameter to expand more details." schema: nullable: true oneOf: - $ref: '#/components/schemas/Int64NullParameter' x-position: 14 x-tzkt-extension: query-parameter - name: migrationId in: query description: "Filter by id of the migration, caused the token transfer. \nClick on the parameter to expand more details." schema: nullable: true oneOf: - $ref: '#/components/schemas/Int64NullParameter' x-position: 15 x-tzkt-extension: query-parameter - name: or.ColsAndVals in: query style: form explode: true schema: type: array items: $ref: '#/components/schemas/ValueTupleOfStringAndListOfInteger' x-position: 16 - name: indexedAt in: query schema: nullable: true oneOf: - $ref: '#/components/schemas/Int32NullParameter' x-position: 17 x-tzkt-extension: query-parameter responses: '200': description: '' content: application/json: schema: type: integer format: int32 /v1/tokens/transfers: get: tags: - Tokens summary: Get token transfers description: Returns a list of token transfers. operationId: Tokens_GetTokenTransfers 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 - 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: 4 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: 5 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: 6 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: 7 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: 8 x-tzkt-extension: json-parameter - name: anyof in: query description: "Filter by any of the specified fields (`from` or `to`).\nExample: `anyof.from.to=tz1...` will return transfers where `from` OR `to` is equal to the specified value.\nThis parameter is useful when you need to get both incoming and outgoing transfers of the account at once. \nClick on the parameter to expand more details." schema: nullable: true oneOf: - $ref: '#/components/schemas/AnyOfParameter' x-position: 9 x-tzkt-extension: anyof-parameter x-tzkt-anyof-parameter: from,to - name: from in: query description: "Filter by sender account address. \nClick on the parameter to expand more details." schema: nullable: true oneOf: - $ref: '#/components/schemas/AccountParameter' x-position: 10 x-tzkt-extension: query-parameter - name: to in: query description: "Filter by target account address. \nClick on the parameter to expand more details." schema: nullable: true oneOf: - $ref: '#/components/schemas/AccountParameter' x-position: 11 x-tzkt-extension: query-parameter - name: amount in: query description: "Filter by amount. \nClick on the parameter to expand more details." schema: nullable: true oneOf: - $ref: '#/components/schemas/NatParameter' x-position: 12 x-tzkt-extension: query-parameter - name: transactionId in: query description: "Filter by id of the transaction, caused the token transfer. \nClick on the parameter to expand more details." schema: nullable: true oneOf: - $ref: '#/components/schemas/Int64NullParameter' x-position: 13 x-tzkt-extension: query-parameter - name: originationId in: query description: "Filter by id of the origination, caused the token transfer. \nClick on the parameter to expand more details." schema: nullable: true oneOf: - $ref: '#/components/schemas/Int64NullParameter' x-position: 14 x-tzkt-extension: query-parameter - name: migrationId in: query description: "Filter by id of the migration, caused the token transfer. \nClick on the parameter to expand more details." schema: nullable: true oneOf: - $ref: '#/components/schemas/Int64NullParameter' x-position: 15 x-tzkt-extension: query-parameter - name: or.ColsAndVals in: query style: form explode: true schema: type: array items: $ref: '#/components/schemas/ValueTupleOfStringAndListOfInteger' x-position: 16 - name: indexedAt in: query schema: nullable: true oneOf: - $ref: '#/components/schemas/Int32NullParameter' x-position: 17 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: 18 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: 19 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: 20 - 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: 21 x-tzkt-extension: query-parameter responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/TokenTransfer' /v1/tokens/historical_balances/{level}: get: tags: - Tokens summary: Get historical token balances description: 'Returns a list of token balances at the end of the specified block. Note, this endpoint is quite heavy, therefore at least one of the filters (`account`, `token.id`, `token.contract` with `token.tokenId`) must be specified.' operationId: Tokens_GetTokenBalances2 parameters: - name: level in: path required: true description: Level of the block at the end of which historical balances must be calculated schema: type: integer format: int32 x-position: 1 - 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: 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: 9 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: 10 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: 11 - 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: 12 x-tzkt-extension: query-parameter responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/TokenBalanceShort' components: schemas: TokenGlobalIdParameter: type: object additionalProperties: false properties: eq: type: string description: '**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \ Specify token standard (`fa1.2` or `fa2`) to get items where the specified field is equal to the specified value. Example: `?type=fa2`.' nullable: true in: type: string description: '**Not equal** filter mode. \ Specify token standard (`fa1.2` or `fa2`) to get items where the specified field is not equal to the specified value. Example: `?type.ne=fa1.2`.' nullable: true TokenBalance: type: object additionalProperties: false properties: id: type: integer description: "Internal TzKT id. \n**[sortable]**" format: int64 account: description: "Owner account. \nClick on the field to expand more details." oneOf: - $ref: '#/components/schemas/Alias' token: description: "Token info. \nClick on the field to expand more details." oneOf: - $ref: '#/components/schemas/TokenInfo' balance: type: string description: "Balance (raw value, not divided by `decimals`). \n**[sortable]**" balanceValue: type: string description: "Balance value in mutez, based on the current token price. \n**[sortable]**" nullable: true transfersCount: type: integer description: "Total number of transfers, affecting the token balance. \n**[sortable]**" format: int32 firstLevel: type: integer description: "Level of the block where the token balance was first changed. \n**[sortable]**" format: int32 firstTime: type: string description: Timestamp of the block where the token balance was first changed. format: date-time lastLevel: type: integer description: "Level of the block where the token balance was last changed. \n**[sortable]**" format: int32 lastTime: type: string description: Timestamp of the block where the token balance was last changed. format: date-time SortParameter: type: object additionalProperties: false properties: asc: type: string description: '**Ascending** sort mode (optional, i.e. `sort.asc=id` is the same as `sort=id`). \ Specify a field name to sort by. Example: `?sort=balance`.' nullable: true desc: type: string description: '**Descending** sort mode. \ Specify a field name to sort by descending. Example: `?sort.desc=id`.' nullable: true x-tzkt-extension: query-parameter AnyOfParameter: type: object additionalProperties: false properties: eq: type: string description: '**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \ Specify a value to get items where any of the specified fields is equal to the specified value. Example: `?anyof.sender.target=tz1WnfXMPaNTBmH7DBPwqCWs9cPDJdkGBTZ8`.' nullable: true in: type: array description: '**In list** (any of) filter mode. \ Specify a comma-separated list of values to get items where any of the specified fields is equal to one of the specified values. Example: `?anyof.sender.target.in=tz1WnfXMPaNTBWnfXMPaNTBWnfXMPaNTBNTB,tz1SiPXX4MYGNJNDSiPXX4MYGNJNDSiPXX4M,null`.' nullable: true items: type: string 'null': type: boolean description: '**Is null** filter mode. \ Use this mode to get items where any of the specified fields is null or not. Example: `?anyof.from.to.null` or `?anyof.from.to.null=false`.' nullable: true x-tzkt-extension: anyof-parameter JsonParameter: type: object additionalProperties: false properties: eq: type: string description: '**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \ Specify a JSON value to get items where the specified field is equal to the specified value. Example: `?parameter.from=tz1...` or `?parameter.signatures.[3].[0]=null` or `?parameter.sigs.[*]=null`.' nullable: true x-tzkt-extension: json-parameter ne: type: string description: '**Not equal** filter mode. \ Specify a JSON value to get items where the specified field is not equal to the specified value. Example: `?parameter.ne=true` or `?parameter.amount.ne=0`.' nullable: true x-tzkt-extension: json-parameter gt: type: string description: '**Greater than** filter mode. \ Specify a string to get items where the specified field is greater than the specified value. Note that all stored JSON values are strings, so this will be a comparison of two strings, so we recommend comparing values of the same type, e.g. numeric strings with numeric strings (`parameter.number.gt=123`), datetime strings with datetime strings (`parameter.date.gt=2021-01-01`), etc. Otherwise, result may surprise you. Example: `?parameter.balance.gt=1234` or `?parameter.time.gt=2021-02-01`.' nullable: true x-tzkt-extension: json-parameter ge: type: string description: '**Greater or equal** filter mode. \ Specify a string to get items where the specified field is greater than equal to the specified value. Note that all stored JSON values are strings, so this will be a comparison of two strings, so we recommend comparing values of the same type, e.g. numeric strings with numeric strings (`parameter.number.gt=123`), datetime strings with datetime strings (`parameter.date.gt=2021-01-01`), etc. Otherwise, result may surprise you. Example: `?parameter.balance.ge=1234` or `?parameter.time.ge=2021-02-01`.' nullable: true x-tzkt-extension: json-parameter lt: type: string description: '**Less than** filter mode. \ Specify a string to get items where the specified field is less than the specified value. Note that all stored JSON values are strings, so this will be a comparison of two strings, so we recommend comparing values of the same type, e.g. numeric strings with numeric strings (`parameter.number.gt=123`), datetime strings with datetime strings (`parameter.date.gt=2021-01-01`), etc. Otherwise, result may surprise you. Example: `?parameter.balance.lt=1234` or `?parameter.time.lt=2021-02-01`.' nullable: true x-tzkt-extension: json-parameter le: type: string description: '**Less or equal** filter mode. \ Specify a string to get items where the specified field is less than or equal to the specified value. Note that all stored JSON values are strings, so this will be a comparison of two strings, so we recommend comparing values of the same type, e.g. numeric strings with numeric strings (`parameter.number.gt=123`), datetime strings with datetime strings (`parameter.date.gt=2021-01-01`), etc. Otherwise, result may surprise you. Example: `?parameter.balance.le=1234` or `?parameter.time.le=2021-02-01`.' nullable: true x-tzkt-extension: json-parameter as: type: string description: '**Same as** filter mode. \ Specify a string template to get items where the specified field matches the specified template. \ This mode supports wildcard `*`. Use `\*` as an escape symbol. Example: `?parameter.as=*mid*` or `?parameter.as=*end`.' nullable: true x-tzkt-extension: json-parameter un: type: string description: '**Unlike** filter mode. \ Specify a string template to get items where the specified field doesn''t match the specified template. This mode supports wildcard `*`. Use `\*` as an escape symbol. Example: `?parameter.un=*mid*` or `?parameter.un=*end`.' nullable: true x-tzkt-extension: json-parameter in: type: array description: '**In list** (any of) filter mode. \ Specify a comma-separated list of strings or JSON array to get items where the specified field is equal to one of the specified values. \ Example: `?parameter.amount.in=1,2,3` or `?parameter.in=[{"from":"tz1","to":"tz2"},{"from":"tz2","to":"tz1"}]`.' nullable: true items: type: string x-tzkt-extension: json-parameter ni: type: array description: '**Not in list** (none of) filter mode. \ Specify a comma-separated list of strings to get items where the specified field is not equal to all the specified values. \ Use `\,` as an escape symbol. Example: `?parameter.amount.ni=1,2,3` or `?parameter.ni=[{"from":"tz1","to":"tz2"},{"from":"tz2","to":"tz1"}]`.' nullable: true items: type: string x-tzkt-extension: json-parameter 'null': type: boolean description: '**Is null** filter mode. \ Use this mode to get items where the specified field is null or not. Example: `?parameter.null` or `?parameter.null=false` or `?parameter.sigs.[0].null=false`.' x-tzkt-extension: json-parameter x-tzkt-extension: json-parameter OffsetParameter: type: object additionalProperties: false properties: el: type: integer description: '**Elements** offset mode (optional, i.e. `offset.el=123` is the same as `offset=123`). \ Skips specified number of elements. Example: `?offset=100`.' format: int32 nullable: true pg: type: integer description: '**Page** offset mode. \ Skips `page * limit` elements. This is a classic pagination. Example: `?offset.pg=1`.' format: int32 nullable: true cr: type: integer description: '**Cursor** offset mode. \ Skips all elements with the `cursor` before (including) the specified value. Cursor is a field used for sorting, e.g. `id`. Avoid using this offset mode with non-unique or non-sequential cursors such as `amount`, `balance`, etc. Example: `?offset.cr=45837`.' format: int64 nullable: true x-tzkt-extension: query-parameter Int64Parameter: type: object additionalProperties: false properties: eq: type: integer description: '**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \ Specify an integer number to get items where the specified field is equal to the specified value. Example: `?balance=1234`.' format: int64 nullable: true ne: type: integer description: '**Not equal** filter mode. \ Specify an integer number to get items where the specified field is not equal to the specified value. Example: `?balance.ne=1234`.' format: int64 nullable: true gt: type: integer description: '**Greater than** filter mode. \ Specify an integer number to get items where the specified field is greater than the specified value. Example: `?balance.gt=1234`.' format: int64 nullable: true ge: type: integer description: '**Greater or equal** filter mode. \ Specify an integer number to get items where the specified field is greater than equal to the specified value. Example: `?balance.ge=1234`.' format: int64 nullable: true lt: type: integer description: '**Less than** filter mode. \ Specify an integer number to get items where the specified field is less than the specified value. Example: `?balance.lt=1234`.' format: int64 nullable: true le: type: integer description: '**Less or equal** filter mode. \ Specify an integer number to get items where the specified field is less than or equal to the specified value. Example: `?balance.le=1234`.' format: int64 nullable: true in: type: array description: '**In list** (any of) filter mode. \ Specify a comma-separated list of integers to get items where the specified field is equal to one of the specified values. Example: `?level.in=12,14,52,69`.' nullable: true items: type: integer format: int64 ni: type: array description: '**Not in list** (none of) filter mode. \ Specify a comma-separated list of integers to get items where the specified field is not equal to all the specified values. Example: `?level.ni=12,14,52,69`.' nullable: true items: type: integer format: int64 empty: type: boolean x-tzkt-extension: query-parameter NatParameter: type: object additionalProperties: false properties: eq: type: string description: '**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \ Specify a `nat` value to get items where the specified field is equal to the specified value. Example: `?balance=1234`.' nullable: true ne: type: string description: '**Not equal** filter mode. \ Specify a `nat` value to get items where the specified field is not equal to the specified value. Example: `?balance.ne=1234`.' nullable: true gt: type: string description: '**Greater than** filter mode. \ Specify a `nat` value to get items where the specified field is greater than the specified value. Example: `?balance.gt=1234`.' nullable: true ge: type: string description: '**Greater or equal** filter mode. \ Specify a `nat` value to get items where the specified field is greater than equal to the specified value. Example: `?balance.ge=1234`.' nullable: true lt: type: string description: '**Less than** filter mode. \ Specify a `nat` value to get items where the specified field is less than the specified value. Example: `?balance.lt=1234`.' nullable: true le: type: string description: '**Less or equal** filter mode. \ Specify a `nat` value to get items where the specified field is less than or equal to the specified value. Example: `?balance.le=1234`.' nullable: true in: type: array description: '**In list** (any of) filter mode. \ Specify a comma-separated list of `nat` values to get items where the specified field is equal to one of the specified values. Example: `?level.in=12,14,52,69`.' nullable: true items: type: string ni: type: array description: '**Not in list** (none of) filter mode. \ Specify a comma-separated list of `nat` values to get items where the specified field is not equal to all the specified values. Example: `?level.ni=12,14,52,69`.' nullable: true items: type: string x-tzkt-extension: query-parameter TokenStandardParameter: type: object additionalProperties: false properties: eq: type: string description: '**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \ Specify token standard (`fa1.2` or `fa2`) to get items where the specified field is equal to the specified value. Example: `?type=fa2`.' nullable: true ne: type: string description: '**Not equal** filter mode. \ Specify token standard (`fa1.2` or `fa2`) to get items where the specified field is not equal to the specified value. Example: `?type.ne=fa1.2`.' nullable: true x-tzkt-extension: query-parameter x-tzkt-query-parameter: fa1.2,fa2 TimestampParameter: type: object additionalProperties: false properties: eq: type: string description: '**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \ Specify a datetime value to get items where the specified field is equal to the specified value. Example: `?timestamp=2020-02-20T02:40:57Z`.' format: date-time nullable: true ne: type: string description: '**Not equal** filter mode. \ Specify a datetime value to get items where the specified field is not equal to the specified value. Example: `?timestamp.ne=2020-02-20T02:40:57Z`.' format: date-time nullable: true gt: type: string description: '**Greater than** filter mode. \ Specify a datetime value to get items where the specified field is greater than the specified value. Example: `?timestamp.gt=2020-02-20T02:40:57Z`.' format: date-time nullable: true ge: type: string description: '**Greater or equal** filter mode. \ Specify a datetime value to get items where the specified field is greater than equal to the specified value. Example: `?timestamp.ge=2020-02-20T02:40:57Z`.' format: date-time nullable: true lt: type: string description: '**Less than** filter mode. \ Specify a datetime value to get items where the specified field is less than the specified value. Example: `?timestamp.lt=2020-02-20T02:40:57Z`.' format: date-time nullable: true le: type: string description: '**Less or equal** filter mode. \ Specify a datetime value to get items where the specified field is less than or equal to the specified value. Example: `?timestamp.le=2020-02-20T02:40:57Z`.' format: date-time nullable: true in: type: array description: '**In list** (any of) filter mode. \ Specify a comma-separated list of datetimes to get items where the specified field is equal to one of the specified values. Example: `?timestamp.in=2020-02-20,2020-02-21`.' nullable: true items: type: string format: date-time ni: type: array description: '**Not in list** (none of) filter mode. \ Specify a comma-separated list of datetimes to get items where the specified field is not equal to all the specified values. Example: `?timestamp.ni=2020-02-20,2020-02-21`.' nullable: true items: type: string format: date-time x-tzkt-extension: query-parameter Token: type: object additionalProperties: false properties: id: type: integer description: "Internal TzKT id (not the same as `tokenId`). \n**[sortable]**" format: int64 contract: description: Contract, created the token. oneOf: - $ref: '#/components/schemas/Alias' tokenId: type: string description: "Token id, unique within the contract. \n**[sortable]**" standard: type: string description: Token standard (`fa1.2` or `fa2`). firstMinter: description: Account, minted the token first. oneOf: - $ref: '#/components/schemas/Alias' firstLevel: type: integer description: "Level of the block where the token was first seen. \n**[sortable]**" format: int32 firstTime: type: string description: Timestamp of the block where the token was first seen. format: date-time lastLevel: type: integer description: "Level of the block where the token was last seen. \n**[sortable]**" format: int32 lastTime: type: string description: Timestamp of the block where the token was last seen. format: date-time transfersCount: type: integer description: "Total number of transfers. \n**[sortable]**" format: int32 balancesCount: type: integer description: "Total number of holders ever seen. \n**[sortable]**" format: int32 holdersCount: type: integer description: "Total number of current holders. \n**[sortable]**" format: int32 totalMinted: type: string description: Total number of minted tokens (raw value, not divided by `decimals`). totalBurned: type: string description: Total number of burned tokens (raw value, not divided by `decimals`). totalSupply: type: string description: Total number of existing tokens (raw value, not divided by `decimals`). metadata: description: "Token metadata. \n**[sortable]**" nullable: true TokenInfoShort: type: object additionalProperties: false properties: id: type: integer description: Internal TzKT id (not the same as `tokenId`). format: int64 contract: description: Contract, created the token. oneOf: - $ref: '#/components/schemas/Alias' tokenId: type: string description: Token id, unique within the contract. standard: type: string description: Token standard (either `fa1.2` or `fa2`). metadata: description: "Token metadata. \n**[sortable]**" nullable: true AccountParameter: type: object additionalProperties: false properties: eq: type: string description: '**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \ Specify a `tz` or `KT` address to get items where the specified field is equal to the specified value. Example: `?sender=tz1WnfXMPaNTBmH7DBPwqCWs9cPDJdkGBTZ8`.' nullable: true ne: type: string description: '**Not equal** filter mode. \ Specify a `tz` or `KT` address to get items where the specified field is not equal to the specified value. Example: `?sender.ne=tz1WnfXMPaNTBmH7DBPwqCWs9cPDJdkGBTZ8`.' nullable: true in: type: array description: '**In list** (any of) filter mode. \ Specify a comma-separated list of addresses to get items where the specified field is equal to one of the specified values. Example: `?sender.in=tz1WnfXMPaNTBWnfXMPaNTBWnfXMPaNTBNTB,tz1SiPXX4MYGNJNDSiPXX4MYGNJNDSiPXX4M`.' nullable: true items: type: string ni: type: array description: '**Not in list** (none of) filter mode. \ Specify a comma-separated list of addresses to get items where the specified field is not equal to all the specified values. Example: `?sender.ni=tz1WnfXMPaNTBWnfXMPaNTBWnfXMPaNTBNTB,tz1SiPXX4MYGNJNDSiPXX4MYGNJNDSiPXX4M`.' nullable: true items: type: string eqx: type: string description: '**Equal to another field** filter mode. \ Specify a field name to get items where the specified fields are equal. Example: `?sender.eqx=target`.' nullable: true nex: type: string description: '**Not equal to another field** filter mode. \ Specify a field name to get items where the specified fields are not equal. Example: `?sender.nex=initiator`.' nullable: true 'null': type: boolean description: '**Is null** filter mode. \ Use this mode to get items where the specified field is null or not. Example: `?initiator.null` or `?initiator.null=false`.' nullable: true inHasNull: type: boolean niHasNull: type: boolean x-tzkt-extension: query-parameter TokenTransfer: type: object additionalProperties: false properties: id: type: integer description: "Internal TzKT id. \n**[sortable]**" format: int64 level: type: integer description: "Level of the block, at which the token transfer was made. \n**[sortable]**" format: int32 timestamp: type: string description: Timestamp of the block, at which the token transfer was made. format: date-time token: description: "Token info. \nClick on the field to expand more details." oneOf: - $ref: '#/components/schemas/TokenInfo' from: description: "Sender account. \nClick on the field to expand more details." nullable: true oneOf: - $ref: '#/components/schemas/Alias' to: description: "Target account. \nClick on the field to expand more details." nullable: true oneOf: - $ref: '#/components/schemas/Alias' amount: type: string description: "Amount of tokens transferred (raw value, not divided by `decimals`). \n**[sortable]**" transactionId: type: integer description: Internal TzKT id of the transaction operation, caused the token transfer. format: int64 nullable: true originationId: type: integer description: Internal TzKT id of the origination operation, caused the token transfer. format: int64 nullable: true migrationId: type: integer description: Internal TzKT id of the migration operation, caused the token transfer. format: int64 nullable: true SelectionParameter: type: object additionalProperties: false properties: fields: type: array description: '**Fields** selection mode (optional, i.e. `select.fields=balance` is the same as `select=balance`). \ Specify a comma-separated list of fields to include into response. Example: `?select=address,balance as b,metadata.name as meta_name` will result in `[ { "address": "asd", "b": 10, "meta_name": "qwe" } ]`.' nullable: true items: type: string values: type: array description: '**Values** selection mode. \ Specify a comma-separated list of fields to include their values into response. Example: `?select.values=address,balance,metadata.name` will result in `[ [ "asd", 10, "qwe" ] ]`.' nullable: true items: type: string x-tzkt-extension: query-parameter TokenInfo: type: object additionalProperties: false properties: id: type: integer description: Internal TzKT id (not the same as `tokenId`). format: int64 contract: description: Contract, created the token. oneOf: - $ref: '#/components/schemas/Alias' tokenId: type: string description: Token id, unique within the contract. standard: type: string description: Token standard (either `fa1.2` or `fa2`). totalSupply: type: string description: Total number of existing tokens (raw value, not divided by `decimals`). metadata: description: "Token metadata. \n**[sortable]**" nullable: true TokenBalanceShort: type: object additionalProperties: false properties: account: description: "Owner account. \nClick on the field to expand more details." oneOf: - $ref: '#/components/schemas/Alias' token: description: "Token info. \nClick on the field to expand more details." oneOf: - $ref: '#/components/schemas/TokenInfoShort' balance: type: string description: "Balance (raw value, not divided by `decimals`). \n**[sortable]**" ValueTupleOfStringAndListOfInteger: type: object additionalProperties: false Int64NullParameter: type: object additionalProperties: false properties: eq: type: integer description: '**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \ Specify an integer number to get items where the specified field is equal to the specified value. Example: `?balance=1234`.' format: int64 nullable: true ne: type: integer description: '**Not equal** filter mode. \ Specify an integer number to get items where the specified field is not equal to the specified value. Example: `?balance.ne=1234`.' format: int64 nullable: true gt: type: integer description: '**Greater than** filter mode. \ Specify an integer number to get items where the specified field is greater than the specified value. Example: `?balance.gt=1234`.' format: int64 nullable: true ge: type: integer description: '**Greater or equal** filter mode. \ Specify an integer number to get items where the specified field is greater than equal to the specified value. Example: `?balance.ge=1234`.' format: int64 nullable: true lt: type: integer description: '**Less than** filter mode. \ Specify an integer number to get items where the specified field is less than the specified value. Example: `?balance.lt=1234`.' format: int64 nullable: true le: type: integer description: '**Less or equal** filter mode. \ Specify an integer number to get items where the specified field is less than or equal to the specified value. Example: `?balance.le=1234`.' format: int64 nullable: true in: type: array description: '**In list** (any of) filter mode. \ Specify a comma-separated list of integers to get items where the specified field is equal to one of the specified values. Example: `?level.in=12,14,52,69`.' nullable: true items: type: integer format: int64 ni: type: array description: '**Not in list** (none of) filter mode. \ Specify a comma-separated list of integers to get items where the specified field is not equal to all the specified values. Example: `?level.ni=12,14,52,69`.' nullable: true items: type: integer format: int64 'null': type: boolean description: '**Is null** filter mode. \ Use this mode to get items where the specified field is null or not. Example: `?nonce.null` or `?nonce.null=false`.' nullable: true x-tzkt-extension: query-parameter Alias: type: object additionalProperties: false properties: alias: type: string description: Account alias name (off-chain data). nullable: true address: type: string description: Account address (public key hash). Int32NullParameter: type: object additionalProperties: false properties: eq: type: integer description: '**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \ Specify an integer number to get items where the specified field is equal to the specified value. Example: `?balance=1234`.' format: int32 nullable: true ne: type: integer description: '**Not equal** filter mode. \ Specify an integer number to get items where the specified field is not equal to the specified value. Example: `?balance.ne=1234`.' format: int32 nullable: true gt: type: integer description: '**Greater than** filter mode. \ Specify an integer number to get items where the specified field is greater than the specified value. Example: `?balance.gt=1234`.' format: int32 nullable: true ge: type: integer description: '**Greater or equal** filter mode. \ Specify an integer number to get items where the specified field is greater than equal to the specified value. Example: `?balance.ge=1234`.' format: int32 nullable: true lt: type: integer description: '**Less than** filter mode. \ Specify an integer number to get items where the specified field is less than the specified value. Example: `?balance.lt=1234`.' format: int32 nullable: true le: type: integer description: '**Less or equal** filter mode. \ Specify an integer number to get items where the specified field is less than or equal to the specified value. Example: `?balance.le=1234`.' format: int32 nullable: true in: type: array description: '**In list** (any of) filter mode. \ Specify a comma-separated list of integers to get items where the specified field is equal to one of the specified values. Example: `?level.in=12,14,52,69`.' nullable: true items: type: integer format: int32 ni: type: array description: '**Not in list** (none of) filter mode. \ Specify a comma-separated list of integers to get items where the specified field is not equal to all the specified values. Example: `?level.ni=12,14,52,69`.' nullable: true items: type: integer format: int32 'null': type: boolean description: '**Is null** filter mode. \ Use this mode to get items where the specified field is null or not. Example: `?nonce.null` or `?nonce.null=false`.' nullable: true x-tzkt-extension: query-parameter Int32Parameter: type: object additionalProperties: false properties: eq: type: integer description: '**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \ Specify an integer number to get items where the specified field is equal to the specified value. Example: `?balance=1234`.' format: int32 nullable: true ne: type: integer description: '**Not equal** filter mode. \ Specify an integer number to get items where the specified field is not equal to the specified value. Example: `?balance.ne=1234`.' format: int32 nullable: true gt: type: integer description: '**Greater than** filter mode. \ Specify an integer number to get items where the specified field is greater than the specified value. Example: `?balance.gt=1234`.' format: int32 nullable: true ge: type: integer description: '**Greater or equal** filter mode. \ Specify an integer number to get items where the specified field is greater than equal to the specified value. Example: `?balance.ge=1234`.' format: int32 nullable: true lt: type: integer description: '**Less than** filter mode. \ Specify an integer number to get items where the specified field is less than the specified value. Example: `?balance.lt=1234`.' format: int32 nullable: true le: type: integer description: '**Less or equal** filter mode. \ Specify an integer number to get items where the specified field is less than or equal to the specified value. Example: `?balance.le=1234`.' format: int32 nullable: true in: type: array description: '**In list** (any of) filter mode. \ Specify a comma-separated list of integers to get items where the specified field is equal to one of the specified values. Example: `?level.in=12,14,52,69`.' nullable: true items: type: integer format: int32 ni: type: array description: '**Not in list** (none of) filter mode. \ Specify a comma-separated list of integers to get items where the specified field is not equal to all the specified values. Example: `?level.ni=12,14,52,69`.' nullable: true items: type: integer format: int32 x-tzkt-extension: query-parameter x-generator: NSwag v14.2.0.0 (NJsonSchema v11.1.0.0 (Newtonsoft.Json v13.0.0.0)) x-tagGroups: - name: REST API tags: - Accounts - BigMaps - Blocks - Commitments - Constants - Contracts - Cycles - Delegates - Domains - Events - Head - Helpers - Operations - Protocols - Quotes - Rewards - Rights - SmartRollups - Software - Staking - Statistics - Tickets - Tokens - Voting - name: WebSocket API tags: - Get Started - Subscriptions - Examples - name: Libraries tags: - Typescript SDK - Taquito extension