{ "x-generator": "NSwag v14.2.0.0 (NJsonSchema v11.1.0.0 (Newtonsoft.Json v13.0.0.0))", "openapi": "3.0.0", "info": { "title": "TzKT 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 😊\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! 😉\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" } ], "paths": { "/v1/accounts": { "get": { "tags": [ "Accounts" ], "summary": "Get accounts", "description": "Returns a list of accounts.", "operationId": "Accounts_Get", "parameters": [ { "name": "id", "in": "query", "description": "Filters by internal id.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "address", "in": "query", "description": "Filters by address.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AddressParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "type", "in": "query", "description": "Filters accounts by type (`user`, `delegate`, `contract`, `rollup`, `smart_rollup`, `ghost`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountTypeParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "user,contract,delegate" }, { "name": "kind", "in": "query", "description": "Filters accounts by contract kind (`delegator_contract` or `smart_contract`)", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ContractKindParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "delegator_contract,smart_contract" }, { "name": "delegate", "in": "query", "description": "Filters accounts by delegate. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "stakedPseudotokens", "in": "query", "description": "Filters accounts by amount of staked pseudotokens.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BigIntegerNullableParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "balance", "in": "query", "description": "Filters accounts by balance", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "staked", "in": "query", "description": "Filters accounts by participation in staking", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BoolParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "lastActivity", "in": "query", "description": "Filters accounts by last activity level (where the account was updated)", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 10, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts delegators by specified field. Supported fields: `id` (default), `balance`, `rollupBonds`, `firstActivity`, `lastActivity`, `numTransactions`, `numContracts`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 11, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 12, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 13 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } } } } } } }, "/v1/accounts/activity": { "get": { "tags": [ "Accounts" ], "summary": "Get accounts activity", "operationId": "Accounts_GetActivity", "parameters": [ { "name": "addresses", "in": "query", "description": "Comma-separated list of account addresses to get activity of.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "roles", "in": "query", "description": "Comma-separated list of activity roles (`sender`, `target`, `initiator`, `mention`) to filter activity by.", "schema": { "type": "string", "nullable": true }, "x-position": 2 }, { "name": "types", "in": "query", "description": "Comma-separated list of activity types (`activation`, `autostaking`, `baking`, `ballot`, `dal_attestation_reward`,\n `dal_entrapment_evidence`, `dal_publish_commitment`, `delegation`, `double_baking`, `double_consensus`, `drain_delegate`, \n `attestation`, `attestation_reward`, `increase_paid_storage`, `migration`, `nonce_revelation`, `origination`, `preattestation`, `proposal`,\n `register_constant`, `reveal`, `revelation_penalty`, `set_delegate_parameters`, `set_deposits_limit`, `sr_add_messages`, `sr_cement`, `sr_execute`,\n `sr_originate`, `sr_publish`, `sr_recover_bond`, `sr_refute`, `staking`, `transaction`, `transfer_ticket`, `tx_rollup_commit`, `tx_rollup_dispatch_tickets`,\n `tx_rollup_finalize_commitment`, `tx_rollup_origination`, `tx_rollup_rejection`, `tx_rollup_remove_commitment`, `tx_rollup_return_bond`, `tx_rollup_submit_batch`,\n `vdf_revelation`, `update_secondary_key`, `ticket_transfer`, `token_transfer`)", "schema": { "type": "string", "nullable": true }, "x-position": 3 }, { "name": "timestamp", "in": "query", "description": "Filter activity by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sort mode: 0 - asc (oldest to newest), 1 - desc (newest to oldest).", "schema": { "default": "Descending", "oneOf": [ { "$ref": "#/components/schemas/SortMode" } ] }, "x-position": 5 }, { "name": "lastId", "in": "query", "description": "Id of the last activity element received, which is used for cursor pagination.", "schema": { "type": "integer", "format": "int64", "nullable": true }, "x-position": 6 }, { "name": "limit", "in": "query", "description": "Number of elements to return.", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 1000.0, "minimum": 0.0 }, "x-position": 7 }, { "name": "micheline", "in": "query", "description": "Format of the parameters, storage and diffs: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string.", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 8 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response.", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 9 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Activity" } } } } } } } }, "/v1/accounts/count": { "get": { "tags": [ "Accounts" ], "summary": "Get accounts count", "description": "Returns a number of accounts.", "operationId": "Accounts_GetCount", "parameters": [ { "name": "type", "in": "query", "description": "Filters accounts by type (`user`, `delegate`, `contract`, `rollup`, `smart_rollup`, `ghost`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountTypeParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "user,contract,delegate" }, { "name": "kind", "in": "query", "description": "Filters accounts by contract kind (`delegator_contract` or `smart_contract`)", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ContractKindParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "delegator_contract,smart_contract" }, { "name": "balance", "in": "query", "description": "Filters accounts by balance", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "staked", "in": "query", "description": "Filters accounts by participation in staking", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BoolParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "firstActivity", "in": "query", "description": "Filters accounts by first activity level (where the account was created)", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/accounts/{address}": { "get": { "tags": [ "Accounts" ], "summary": "Get account by address", "description": "Returns an account with the specified address.", "operationId": "Accounts_GetByAddress", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Account address", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } } } } }, "/v1/accounts/{address}/contracts": { "get": { "tags": [ "Accounts" ], "summary": "Get account contracts", "description": "Returns a list of contracts created by (or related to) the specified account.", "operationId": "Accounts_GetContracts", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Account address (starting with tz or KT)", "schema": { "type": "string" }, "x-position": 1 }, { "name": "sort", "in": "query", "description": "Sorts contracts by specified field. Supported fields: `id` (default, desc), `balance`, `creationLevel`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 4 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedContract" } } } } } } } }, "/v1/accounts/{address}/delegators": { "get": { "tags": [ "Accounts" ], "summary": "Get account delegators", "description": "Returns a list of accounts delegated to the specified account.", "operationId": "Accounts_GetDelegators", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Account address (starting with tz)", "schema": { "type": "string" }, "x-position": 1 }, { "name": "type", "in": "query", "description": "Filters delegators by type (`user`, `delegate`, `contract`, `rollup`, `smart_rollup`, `ghost`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountTypeParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "user,contract,delegate" }, { "name": "balance", "in": "query", "description": "Filters delegators by balance.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "delegationLevel", "in": "query", "description": "Number of items to skip", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts delegators by specified field. Supported fields: `delegationLevel` (default, desc), `balance`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 7 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Delegator" } } } } } } } }, "/v1/accounts/{address}/counter": { "get": { "tags": [ "Accounts" ], "summary": "Get counter", "description": "Returns account counter", "operationId": "Accounts_GetCounter", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Account address (starting with tz or KT)", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/accounts/{address}/balance": { "get": { "tags": [ "Accounts" ], "summary": "Get balance", "description": "Returns account balance", "operationId": "Accounts_GetBalance", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Account address (starting with tz or KT)", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } } } } }, "/v1/accounts/{address}/balance_history/{level}": { "get": { "tags": [ "Accounts" ], "summary": "Get balance at level", "description": "Returns account balance* at the specified block. \n\\* - for non-baker tz-accounts historical balances do not include staked tez,\nbecause stakers do not really have staked tez on their balance, they have staking pseudotokens instead.\nIf you want to get a full historical balance, including staked tez, use the Tezos node RPC:\n`/chains/main/blocks/{level}/context/contracts/{address}/full_balance`.", "operationId": "Accounts_GetBalanceAtLevel", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Account address (starting with tz or KT)", "schema": { "type": "string" }, "x-position": 1 }, { "name": "level", "in": "path", "required": true, "description": "Block height at which you want to know account balance", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } } } } }, "/v1/accounts/{address}/balance_history/{datetime}": { "get": { "tags": [ "Accounts" ], "summary": "Get balance at date", "description": "Returns account balance* at the specified datetime. \n\\* - for non-baker tz-accounts historical balances do not include staked tez,\nbecause stakers do not really have staked tez on their balance, they have staking pseudotokens instead.\nIf you want to get a full historical balance, including staked tez, use the Tezos node RPC:\n`/chains/main/blocks/{level}/context/contracts/{address}/full_balance`.", "operationId": "Accounts_GetBalanceAtDate", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Account address (starting with tz or KT)", "schema": { "type": "string" }, "x-position": 1 }, { "name": "datetime", "in": "path", "required": true, "description": "Datetime at which you want to know account balance (e.g. `2020-01-01`, or `2019-12-30T23:42:59Z`)", "schema": { "type": "string", "format": "date-time" }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } } } } }, "/v1/accounts/{address}/balance_history": { "get": { "tags": [ "Accounts" ], "summary": "Get balance history", "description": "Returns time series with historical balances* (only changes, without duplicates). \n\\* - for non-baker tz-accounts historical balances do not include staked tez,\nbecause stakers do not really have staked tez on their balance, they have staking pseudotokens instead.\nIf you want to get a full historical balance, including staked tez, use the Tezos node RPC:\n`/chains/main/blocks/{level}/context/contracts/{address}/full_balance`.", "operationId": "Accounts_GetBalanceHistory", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Account address (starting with tz or KT)", "schema": { "type": "string" }, "x-position": 1 }, { "name": "step", "in": "query", "description": "Step of the time series, for example if `step = 1000` you will get balances at blocks `1000, 2000, 3000, ...`.", "schema": { "type": "integer", "format": "int32", "nullable": true }, "x-position": 2 }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts historical balances by specified field. Supported fields: `level`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "type": "integer", "format": "int32", "default": 0 }, "x-position": 5 }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 6 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 7 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoricalBalance" } } } } } } } }, "/v1/accounts/{address}/report": { "get": { "tags": [ "Accounts" ], "summary": "Get account report", "description": "Exports account balance report in .csv format", "operationId": "Accounts_GetBalanceReport", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Account address (starting with tz or KT)", "schema": { "type": "string" }, "x-position": 1 }, { "name": "from", "in": "query", "description": "Start of the datetime range to filter by (ISO 8601, e.g. 2019-11-31)", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 2 }, { "name": "to", "in": "query", "description": "End of the datetime range to filter by (ISO 8601, e.g. 2019-12-31)", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 3 }, { "name": "currency", "in": "query", "description": "Currency to convert amounts to (`btc`, `eur`, `usd`, `cny`, `jpy`, `krw`, `eth`, `gbp`)", "schema": { "type": "string", "nullable": true }, "x-position": 4 }, { "name": "historical", "in": "query", "description": "`true` if you want to use historical prices, `false` to use current price", "schema": { "type": "boolean", "default": false }, "x-position": 5 }, { "name": "delimiter", "in": "query", "description": "Column delimiter (`comma`, `semicolon`)", "schema": { "type": "string", "default": "comma" }, "x-position": 6 }, { "name": "separator", "in": "query", "description": "Decimal separator (`comma`, `point`)", "schema": { "type": "string", "default": "point" }, "x-position": 7 } ], "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/v1/bigmaps/count": { "get": { "tags": [ "BigMaps" ], "summary": "Get bigmaps count", "description": "Returns the total number of bigmaps.", "operationId": "BigMaps_GetBigMapsCount", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/bigmaps": { "get": { "tags": [ "BigMaps" ], "summary": "Get bigmaps", "description": "Returns a list of bigmaps.", "operationId": "BigMaps_GetBigMaps", "parameters": [ { "name": "contract", "in": "query", "description": "Filters bigmaps by smart contract address.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "path", "in": "query", "description": "Filters bigmaps by path in the contract storage.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/StringParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "tags", "in": "query", "description": "Filters bigmaps by tags: `metadata`, `token_metadata`, `ledger`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BigMapTagsParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "metadata,token_metadata,ledger" }, { "name": "active", "in": "query", "description": "Filters bigmaps by status: `true` - active, `false` - removed.", "schema": { "type": "boolean", "nullable": true }, "x-position": 4 }, { "name": "lastLevel", "in": "query", "description": "Filters bigmaps by the last update level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts bigmaps by specified field. Supported fields: `id` (default), `ptr`, `firstLevel`, `lastLevel`, `totalKeys`, `activeKeys`, `updates`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 9 }, { "name": "micheline", "in": "query", "description": "Format of the bigmap key and value type: `0` - JSON, `2` - Micheline", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 10 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BigMap" } } } } } } } }, "/v1/bigmaps/keys": { "get": { "tags": [ "BigMaps" ], "summary": "Get bigmap keys", "description": "Returns a list of all bigmap keys.", "operationId": "BigMaps_GetBigMapKeys", "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/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "bigmap", "in": "query", "description": "Filter by bigmap ptr. \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": "active", "in": "query", "description": "Filters by status: `true` - active, `false` - removed.", "schema": { "type": "boolean", "nullable": true }, "x-position": 3 }, { "name": "hash", "in": "query", "description": "Filter by key hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ExpressionParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "key", "in": "query", "description": "Filter by key. \nNote, this parameter supports the following format: `key{.path?}{.mode?}=...`,\nso you can specify a path to a particular field to filter by (for example, `?key.foo.in=bar,baz`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonParameter" } ] }, "x-position": 5, "x-tzkt-extension": "json-parameter" }, { "name": "value", "in": "query", "description": "Filter by value. \nNote, this parameter supports the following format: `value{.path?}{.mode?}=...`,\nso you can specify a path to a particular field to filter by (for example, `?value.foo.in=bar,baz`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonParameter" } ] }, "x-position": 6, "x-tzkt-extension": "json-parameter" }, { "name": "firstLevel", "in": "query", "description": "Filter by level of the block where the key was first seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "firstTime", "in": "query", "description": "Filter by timestamp (ISO 8601) of the block where the key was first seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "lastLevel", "in": "query", "description": "Filter by level of the block where the key was last seen. \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": "lastTime", "in": "query", "description": "Filter by timestamp (ISO 8601) of the block where the key was last seen. \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": "updates", "in": "query", "description": "Filter by number of actions with the bigmap key. \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": "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": 12, "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": 13, "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": 14 }, { "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": 15, "x-tzkt-extension": "query-parameter" }, { "name": "micheline", "in": "query", "description": "Format of the `key` and `value` fields: `0` - JSON, `2` - Micheline", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 16 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BigMapKeyFull" } } } } } } } }, "/v1/bigmaps/updates/count": { "get": { "tags": [ "BigMaps" ], "summary": "Get bigmap updates count", "description": "Returns a total number of bigmap updates.", "operationId": "BigMaps_GetBigMapUpdates", "parameters": [ { "name": "bigmap", "in": "query", "description": "Filters by bigmap ptr", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "path", "in": "query", "description": "Filters by bigmap path", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/StringParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "contract", "in": "query", "description": "Filters by bigmap contract", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "tags", "in": "query", "description": "Filters by bigmap tags: `metadata`, `token_metadata`, `ledger`", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BigMapTagsParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "metadata,token_metadata,ledger" }, { "name": "action", "in": "query", "description": "Filters by action", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BigMapActionParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "allocate,add_key,update_key,remove_key,remove" }, { "name": "value", "in": "query", "description": "Filters by JSON value. Note, this query parameter supports the following format: `?value{.path?}{.mode?}=...`,\n so you can specify a path to a particular field to filter by, for example: `?value.balance.gt=...`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonParameter" } ] }, "x-position": 6, "x-tzkt-extension": "json-parameter" }, { "name": "level", "in": "query", "description": "Filters by level", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BigMapUpdate" } } } } } } } }, "/v1/bigmaps/updates": { "get": { "tags": [ "BigMaps" ], "summary": "Get bigmap updates", "description": "Returns a list of all bigmap updates.", "operationId": "BigMaps_GetBigMapUpdates2", "parameters": [ { "name": "bigmap", "in": "query", "description": "Filters by bigmap ptr", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "path", "in": "query", "description": "Filters by bigmap path", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/StringParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "contract", "in": "query", "description": "Filters by bigmap contract", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "tags", "in": "query", "description": "Filters by bigmap tags: `metadata`, `token_metadata`, `ledger`", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BigMapTagsParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "metadata,token_metadata,ledger" }, { "name": "action", "in": "query", "description": "Filters by action", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BigMapActionParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "allocate,add_key,update_key,remove_key,remove" }, { "name": "value", "in": "query", "description": "Filters by JSON value. Note, this query parameter supports the following format: `?value{.path?}{.mode?}=...`,\n so you can specify a path to a particular field to filter by, for example: `?value.balance.gt=...`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonParameter" } ] }, "x-position": 6, "x-tzkt-extension": "json-parameter" }, { "name": "level", "in": "query", "description": "Filters by level", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts bigmaps by specified field. Supported fields: `id` (default), `ptr`, `firstLevel`, `lastLevel`, `totalKeys`, `activeKeys`, `updates`.", "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", "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", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 11 }, { "name": "micheline", "in": "query", "description": "Format of the bigmap key and value type: `0` - JSON, `2` - Micheline", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 12 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BigMapUpdate" } } } } } } } }, "/v1/bigmaps/{id}": { "get": { "tags": [ "BigMaps" ], "summary": "Get bigmap by Id", "description": "Returns a bigmap with the specified Id.", "operationId": "BigMaps_GetBigMapById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Bigmap Id", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "micheline", "in": "query", "description": "Format of the bigmap key and value type: `0` - JSON, `2` - Micheline", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BigMap" } } } } } } }, "/v1/bigmaps/{id}/type": { "get": { "tags": [ "BigMaps" ], "summary": "Get bigmap type", "description": "Returns a type of the bigmap with the specified Id in Micheline format (with annotations).", "operationId": "BigMaps_GetBigMapType", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Bigmap Id", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MichelinePrim" } } } } } } }, "/v1/bigmaps/{id}/keys": { "get": { "tags": [ "BigMaps" ], "summary": "Get bigmap keys", "description": "Returns a list of bigmap keys.", "operationId": "BigMaps_GetKeys", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Bigmap Id", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "active", "in": "query", "description": "Filters keys by status: `true` - active, `false` - removed.", "schema": { "type": "boolean", "nullable": true }, "x-position": 2 }, { "name": "key", "in": "query", "description": "Filters keys by JSON key. Note, this query parameter supports the following format: `?key{.path?}{.mode?}=...`,\n so you can specify a path to a particular field to filter by, for example: `?key.token_id=...`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonParameter" } ] }, "x-position": 3, "x-tzkt-extension": "json-parameter" }, { "name": "value", "in": "query", "description": "Filters keys by JSON value. Note, this query parameter supports the following format: `?value{.path?}{.mode?}=...`,\n so you can specify a path to a particular field to filter by, for example: `?value.balance.gt=...`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonParameter" } ] }, "x-position": 4, "x-tzkt-extension": "json-parameter" }, { "name": "lastLevel", "in": "query", "description": "Filters bigmap keys by the last update level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts bigmap keys by specified field. Supported fields: `id` (default), `firstLevel`, `lastLevel`, `updates`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 9 }, { "name": "micheline", "in": "query", "description": "Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 10 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BigMapKey" } } } } } } } }, "/v1/bigmaps/{id}/keys/{key}": { "get": { "tags": [ "BigMaps" ], "summary": "Get bigmap key", "description": "Returns the specified bigmap key.", "operationId": "BigMaps_GetKey", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Bigmap Id", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "key", "in": "path", "required": true, "description": "Either a key hash (`expr123...`) or a plain value (`foo...`).\n Even if the key is complex (an object or an array), you can specify it as is, for example, `/keys/{\"address\":\"tz123\",\"nat\":\"123\"}`.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "micheline", "in": "query", "description": "Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 3 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BigMapKey" } } } } } } }, "/v1/bigmaps/{id}/keys/{key}/updates": { "get": { "tags": [ "BigMaps" ], "summary": "Get bigmap key updates", "description": "Returns updates history for the specified bigmap key.", "operationId": "BigMaps_GetKeyUpdates", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Bigmap Id", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "key", "in": "path", "required": true, "description": "Either a key hash (`expr123...`) or a plain value (`foo...`).\n Even if the key is complex (an object or an array), you can specify it as is, for example, `/keys/{\"address\":\"tz123\",\"nat\":\"123\"}`.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "sort", "in": "query", "description": "Sorts bigmap updates by specified field. Supported fields: `id` (default).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 5 }, { "name": "micheline", "in": "query", "description": "Format of the key value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 6 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BigMapKeyUpdate" } } } } } } } }, "/v1/bigmaps/{id}/historical_keys/{level}": { "get": { "tags": [ "BigMaps" ], "summary": "Get historical keys", "description": "Returns a list of bigmap keys at the specific block.", "operationId": "BigMaps_GetHistoricalKeys", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Bigmap Id", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "level", "in": "path", "required": true, "description": "Level of the block at which you want to get bigmap keys", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "active", "in": "query", "description": "Filters keys by status: `true` - active, `false` - removed.", "schema": { "type": "boolean", "nullable": true }, "x-position": 3 }, { "name": "key", "in": "query", "description": "Filters keys by JSON key. Note, this query parameter supports the following format: `?key{.path?}{.mode?}=...`,\n so you can specify a path to a particular field to filter by, for example: `?key.token_id=...`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonParameter" } ] }, "x-position": 4, "x-tzkt-extension": "json-parameter" }, { "name": "value", "in": "query", "description": "Filters keys by JSON value. Note, this query parameter supports the following format: `?value{.path?}{.mode?}=...`,\n so you can specify a path to a particular field to filter by, for example: `?value.balance.gt=...`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonParameter" } ] }, "x-position": 5, "x-tzkt-extension": "json-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts bigmap keys by specified field. Supported fields: `id` (default).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 9 }, { "name": "micheline", "in": "query", "description": "Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 10 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BigMapKeyHistorical" } } } } } } } }, "/v1/bigmaps/{id}/historical_keys/{level}/{key}": { "get": { "tags": [ "BigMaps" ], "summary": "Get historical key", "description": "Returns the specified bigmap key at the specific block.", "operationId": "BigMaps_GetKey2", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Bigmap Id", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "level", "in": "path", "required": true, "description": "Level of the block at which you want to get bigmap key", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "key", "in": "path", "required": true, "description": "Either a key hash (`expr123...`) or a plain value (`foo...`).\n Even if the key is complex (an object or an array), you can specify it as is, for example, `/keys/{\"address\":\"tz123\",\"nat\":\"123\"}`.", "schema": { "type": "string" }, "x-position": 3 }, { "name": "micheline", "in": "query", "description": "Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 4 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BigMapKeyHistorical" } } } } } } }, "/v1/blocks/count": { "get": { "tags": [ "Blocks" ], "summary": "Get blocks count", "description": "Returns the total number of blocks.", "operationId": "Blocks_GetCount", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/blocks": { "get": { "tags": [ "Blocks" ], "summary": "Get blocks", "description": "Returns a list of blocks.", "operationId": "Blocks_Get", "parameters": [ { "name": "anyof", "in": "query", "description": "Filters by any of the specified fields. Example: `anyof.proposer.producer=tz1...`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AnyOfParameter" } ] }, "x-position": 1, "x-tzkt-extension": "anyof-parameter", "x-tzkt-anyof-parameter": "proposer,producer" }, { "name": "proposer", "in": "query", "description": "Filters blocks by block proposer. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "producer", "in": "query", "description": "Filters blocks by block producer. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters blocks by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters blocks by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DateTimeParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "blockRound", "in": "query", "description": "Filters blocks by block round.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts blocks by specified field. Supported fields: `id` (default), `level`, `payloadRound`, `blockRound`, `attestationPower`, `reward`, `bonus`, `fees`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 10 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 11 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Block" } } } } } } } }, "/v1/blocks/{hash}": { "get": { "tags": [ "Blocks" ], "summary": "Get block by hash", "description": "Returns a block with the specified hash.", "operationId": "Blocks_GetByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Block hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "operations", "in": "query", "description": "Flag indicating whether to include block operations into returned object or not", "schema": { "type": "boolean", "default": false }, "x-position": 2 }, { "name": "micheline", "in": "query", "description": "Format of the parameters, storage and diffs: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 3 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 4 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Block" } } } } } } }, "/v1/blocks/{level}": { "get": { "tags": [ "Blocks" ], "summary": "Get block by level", "description": "Returns a block at the specified level.", "operationId": "Blocks_GetByLevel", "parameters": [ { "name": "level", "in": "path", "required": true, "description": "Block level", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "operations", "in": "query", "description": "Flag indicating whether to include block operations into returned object or not", "schema": { "type": "boolean", "default": false }, "x-position": 2 }, { "name": "micheline", "in": "query", "description": "Format of the parameters, storage and diffs: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 3 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 4 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Block" } } } } } } }, "/v1/blocks/{level}/timestamp": { "get": { "tags": [ "Blocks" ], "summary": "Get timestamp by level", "description": "Returns a timestamp of the block at the specified level.", "operationId": "Blocks_GetByLevel2", "parameters": [ { "name": "level", "in": "path", "required": true, "description": "Block level", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string", "format": "date-time" } } } } } } }, "/v1/blocks/{timestamp}": { "get": { "tags": [ "Blocks" ], "summary": "Get block by timestamp", "description": "Returns a block closest to the specified timestamp.", "operationId": "Blocks_GetByDate", "parameters": [ { "name": "timestamp", "in": "path", "required": true, "description": "Timestamp, e.g. `2020-01-01T00:00:00Z`", "schema": { "type": "string", "format": "date-time" }, "x-position": 1 }, { "name": "operations", "in": "query", "description": "Flag indicating whether to include block operations into returned object or not", "schema": { "type": "boolean", "default": false }, "x-position": 2 }, { "name": "micheline", "in": "query", "description": "Format of the parameters, storage and diffs: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 3 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 4 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Block" } } } } } } }, "/v1/blocks/{timestamp}/level": { "get": { "tags": [ "Blocks" ], "summary": "Get level by timestamp", "description": "Returns a level of the block closest to the specified timestamp.", "operationId": "Blocks_GetByDate2", "parameters": [ { "name": "timestamp", "in": "path", "required": true, "description": "Timestamp, e.g. `2020-01-01T00:00:00Z`", "schema": { "type": "string", "format": "date-time" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/commitments/{address}": { "get": { "tags": [ "Commitments" ], "summary": "Get commitment by blinded address", "description": "Returns a commitment with the specified blinded address.", "operationId": "Commitments_Get", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Blinded address (starting with btz)", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Commitment" } } } } } } }, "/v1/commitments": { "get": { "tags": [ "Commitments" ], "summary": "Get commitments", "description": "Returns a list of commitments.", "operationId": "Commitments_GetAll", "parameters": [ { "name": "activated", "in": "query", "description": "Filters commitments by activation status", "schema": { "type": "boolean", "nullable": true }, "x-position": 1 }, { "name": "activationLevel", "in": "query", "description": "Filters commitments by activation level", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32NullParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "balance", "in": "query", "description": "Filters commitments by activated balance", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts delegators by specified field. Supported fields: `id` (default), `balance`, `activationLevel`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 7 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Commitment" } } } } } } } }, "/v1/commitments/count": { "get": { "tags": [ "Commitments" ], "summary": "Get commitments count", "description": "Returns a number of commitments.", "operationId": "Commitments_GetCount", "parameters": [ { "name": "activated", "in": "query", "description": "Filters commitments by activation status", "schema": { "type": "boolean", "nullable": true }, "x-position": 1 }, { "name": "balance", "in": "query", "description": "Filters commitments by activated balance", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/constants": { "get": { "tags": [ "Constants" ], "summary": "Get global constants", "description": "Returns a list of global constants.", "operationId": "Constants_Get", "parameters": [ { "name": "address", "in": "query", "description": "Filters constants by global address (starts with `expr..`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ExpressionParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "creationLevel", "in": "query", "description": "Filters constants by creation level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "creationTime", "in": "query", "description": "Filters constants by creation time.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "creator", "in": "query", "description": "Filters constants by creator.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "refs", "in": "query", "description": "Filters constants by number of refs.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "size", "in": "query", "description": "Filters constants by size in bytes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts delegators by specified field. Supported fields: `id` (default), `creationLevel`, `size`, `refs`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 10 }, { "name": "format", "in": "query", "description": "Constant value format (`0` - micheline, `1` - michelson, `2` - bytes (base64))", "schema": { "type": "integer", "format": "int32", "default": 0, "maximum": 2.0, "minimum": 0.0 }, "x-position": 11 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Constant" } } } } } } } }, "/v1/constants/{address}": { "get": { "tags": [ "Constants" ], "summary": "Get global constant by address", "description": "Returns global constant with specified address (expression hash).", "operationId": "Constants_GetByAddress", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Global address (starts with `expr..`)", "schema": { "type": "string" }, "x-position": 1 }, { "name": "format", "in": "query", "description": "Constant value format (`0` - micheline, `1` - michelson, `2` - bytes (base64))", "schema": { "type": "integer", "format": "int32", "default": 0, "maximum": 2.0, "minimum": 0.0 }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Constant" } } } } } } }, "/v1/constants/count": { "get": { "tags": [ "Constants" ], "summary": "Get global constants count", "description": "Returns a number of global constants.", "operationId": "Constants_GetCount", "parameters": [ { "name": "refs", "in": "query", "description": "Filters constants by number of refs.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/contracts": { "get": { "tags": [ "Contracts" ], "summary": "Get contracts", "description": "Returns a list of contract accounts.", "operationId": "Contracts_Get", "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": "address", "in": "query", "description": "Filter by address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AddressParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "kind", "in": "query", "description": "Filter by kind (`delegator_contract`, `smart_contract`, or `asset`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ContractKindParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "delegator_contract,smart_contract" }, { "name": "tzips", "in": "query", "description": "Filter by tzips (`fa1`, `fa12`, or `fa2`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ContractTagsParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "fa1,fa12,fa2" }, { "name": "balance", "in": "query", "description": "Filter by balance. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "creator", "in": "query", "description": "Filter by creator. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "delegate", "in": "query", "description": "Filter by delegate. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "firstActivity", "in": "query", "description": "Filter by level of the block where the contract was first seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "firstActivityTime", "in": "query", "description": "Filter by timestamp (ISO 8601) of the block where the contract was first seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "lastActivity", "in": "query", "description": "Filter by level of the block where the contract was last 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": "lastActivityTime", "in": "query", "description": "Filter by timestamp (ISO 8601) of the block where the contract was last 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": "typeHash", "in": "query", "description": "Filter by 32-bit hash of contract parameter and storage types (helpful for searching similar contracts). \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": "codeHash", "in": "query", "description": "Filter by 32-bit hash of contract code (helpful for searching same contracts). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 13, "x-tzkt-extension": "query-parameter" }, { "name": "tokensCount", "in": "query", "description": "Filter by number of different tokens minted within the contract. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 14, "x-tzkt-extension": "query-parameter" }, { "name": "ticketsCount", "in": "query", "description": "Filter by number of different tickets minted within the contract. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "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" }, { "name": "includeStorage", "in": "query", "description": "Specifies whether to include contract storage into response.", "schema": { "type": "boolean", "default": false }, "x-position": 20 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Contract" } } } } } } } }, "/v1/contracts/count": { "get": { "tags": [ "Contracts" ], "summary": "Get contracts count", "description": "Returns a number of contract accounts.", "operationId": "Contracts_GetCount", "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": "address", "in": "query", "description": "Filter by address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AddressParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "kind", "in": "query", "description": "Filter by kind (`delegator_contract`, `smart_contract`, or `asset`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ContractKindParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "delegator_contract,smart_contract" }, { "name": "tzips", "in": "query", "description": "Filter by tzips (`fa1`, `fa12`, or `fa2`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ContractTagsParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "fa1,fa12,fa2" }, { "name": "balance", "in": "query", "description": "Filter by balance. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "creator", "in": "query", "description": "Filter by creator. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "delegate", "in": "query", "description": "Filter by delegate. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "firstActivity", "in": "query", "description": "Filter by level of the block where the contract was first seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "firstActivityTime", "in": "query", "description": "Filter by timestamp (ISO 8601) of the block where the contract was first seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "lastActivity", "in": "query", "description": "Filter by level of the block where the contract was last 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": "lastActivityTime", "in": "query", "description": "Filter by timestamp (ISO 8601) of the block where the contract was last 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": "typeHash", "in": "query", "description": "Filter by 32-bit hash of contract parameter and storage types (helpful for searching similar contracts). \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": "codeHash", "in": "query", "description": "Filter by 32-bit hash of contract code (helpful for searching same contracts). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 13, "x-tzkt-extension": "query-parameter" }, { "name": "tokensCount", "in": "query", "description": "Filter by number of different tokens minted within the contract. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 14, "x-tzkt-extension": "query-parameter" }, { "name": "ticketsCount", "in": "query", "description": "Filter by number of different tickets minted within the contract. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 15, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/contracts/{address}": { "get": { "tags": [ "Contracts" ], "summary": "Get contract by address", "description": "Returns a contract account with the specified address.", "operationId": "Contracts_GetByAddress", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address (starting with KT)", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contract" } } } } } } }, "/v1/contracts/{address}/same": { "get": { "tags": [ "Contracts" ], "summary": "Get same contracts", "description": "Returns contracts which have the same script as the specified one.\nNote, contract scripts are compared by 32-bit hash, so in very rare cases there may be collisions.", "operationId": "Contracts_GetSame", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address (starting with KT)", "schema": { "type": "string" }, "x-position": 1 }, { "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": 2, "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": 3, "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": 4 }, { "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": 5, "x-tzkt-extension": "query-parameter" }, { "name": "includeStorage", "in": "query", "description": "Specifies whether to include contract storage value in response.", "schema": { "type": "boolean", "default": false }, "x-position": 6 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Contract" } } } } } } } }, "/v1/contracts/{address}/similar": { "get": { "tags": [ "Contracts" ], "summary": "Get similar contracts", "description": "Returns contracts which have the same interface (parameter and storage types) as the specified one.\nNote, contract parameter and storage types are compared by 32-bit hash, so in very rare cases there may be collisions.", "operationId": "Contracts_GetSimilar", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address (starting with KT)", "schema": { "type": "string" }, "x-position": 1 }, { "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": 2, "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": 3, "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": 4 }, { "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": 5, "x-tzkt-extension": "query-parameter" }, { "name": "includeStorage", "in": "query", "description": "Specifies whether to include contract storage value in response.", "schema": { "type": "boolean", "default": false }, "x-position": 6 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Contract" } } } } } } } }, "/v1/contracts/{address}/code": { "get": { "tags": [ "Contracts" ], "summary": "Get contract code", "description": "Returns a code of the specified contract.", "operationId": "Contracts_GetCode", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address (starting with KT)", "schema": { "type": "string" }, "x-position": 1 }, { "name": "level", "in": "query", "description": "Level at which contract code should be taken. If `0` or not specified, the current value will be returned.", "schema": { "type": "integer", "format": "int32", "default": 0 }, "x-position": 2 }, { "name": "format", "in": "query", "description": "Code format (`0` - micheline, `1` - michelson, `2` - bytes (base64))", "schema": { "type": "integer", "format": "int32", "default": 0, "maximum": 2.0, "minimum": 0.0 }, "x-position": 3 } ], "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/v1/contracts/{address}/interface": { "get": { "tags": [ "Contracts" ], "summary": "Get JSON Schema [2020-12] interface for the contract", "description": "Returns standard JSON Schema for contract storage, entrypoints, and Big_map entries.", "operationId": "Contracts_GetInterface", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractInterface" } } } } } } }, "/v1/contracts/{address}/entrypoints": { "get": { "tags": [ "Contracts" ], "summary": "Get contract entrypoints", "description": "Returns entrypoints of the specified contract.", "operationId": "Contracts_GetEntrypoints", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address (starting with KT)", "schema": { "type": "string" }, "x-position": 1 }, { "name": "all", "in": "query", "description": "If true, returns all entrypoints, including unused ones.\n Unused means that the entrypoint can be normalized to a more specific one.\n For example here `(or %entry1 (unit %entry2) (nat %entry3))` the `%entry1` is unused entrypoint\n because it can be normalized to `%entry2` or `%entry3`", "schema": { "type": "boolean", "default": false }, "x-position": 2 }, { "name": "json", "in": "query", "description": "Include parameters schema in human-readable JSON format", "schema": { "type": "boolean", "default": true }, "x-position": 3 }, { "name": "micheline", "in": "query", "description": "Include parameters schema in micheline format", "schema": { "type": "boolean", "default": false }, "x-position": 4 }, { "name": "michelson", "in": "query", "description": "Include parameters schema in michelson format", "schema": { "type": "boolean", "default": false }, "x-position": 5 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Entrypoint" } } } } } } } }, "/v1/contracts/{address}/entrypoints/{name}": { "get": { "tags": [ "Contracts" ], "summary": "Get entrypoint by name", "description": "Returns contract's entrypoint with specified name.", "operationId": "Contracts_GetEntrypointByName", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address (starting with KT)", "schema": { "type": "string" }, "x-position": 1 }, { "name": "name", "in": "path", "required": true, "description": "Entrypoint name", "schema": { "type": "string" }, "x-position": 2 }, { "name": "json", "in": "query", "description": "Include parameters schema in human-readable JSON format", "schema": { "type": "boolean", "default": true }, "x-position": 3 }, { "name": "micheline", "in": "query", "description": "Include parameters schema in micheline format", "schema": { "type": "boolean", "default": false }, "x-position": 4 }, { "name": "michelson", "in": "query", "description": "Include parameters schema in michelson format", "schema": { "type": "boolean", "default": false }, "x-position": 5 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entrypoint" } } } } } } }, "/v1/contracts/{address}/views": { "get": { "tags": [ "Contracts" ], "summary": "Get contract views", "description": "Returns all views of the specified contract.", "operationId": "Contracts_GetContractViews", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address (starting with KT)", "schema": { "type": "string" }, "x-position": 1 }, { "name": "json", "in": "query", "description": "Include parameter and return types in human-readable JSON format", "schema": { "type": "boolean", "default": true }, "x-position": 2 }, { "name": "micheline", "in": "query", "description": "Include parameter and return types in micheline format", "schema": { "type": "boolean", "default": false }, "x-position": 3 }, { "name": "michelson", "in": "query", "description": "Include parameter and return types in michelson format", "schema": { "type": "boolean", "default": false }, "x-position": 4 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContractView" } } } } } } } }, "/v1/contracts/{address}/views/{name}": { "get": { "tags": [ "Contracts" ], "summary": "Get view by name", "description": "Returns contract view with specified name.", "operationId": "Contracts_GetContractViewByName", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address (starting with KT)", "schema": { "type": "string" }, "x-position": 1 }, { "name": "name", "in": "path", "required": true, "description": "View name", "schema": { "type": "string" }, "x-position": 2 }, { "name": "json", "in": "query", "description": "Include parameter and return types in human-readable JSON format", "schema": { "type": "boolean", "default": true }, "x-position": 3 }, { "name": "micheline", "in": "query", "description": "Include parameter and return types in micheline format", "schema": { "type": "boolean", "default": false }, "x-position": 4 }, { "name": "michelson", "in": "query", "description": "Include parameter and return types in michelson format", "schema": { "type": "boolean", "default": false }, "x-position": 5 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractView" } } } } } } }, "/v1/contracts/{address}/entrypoints/{name}/build": { "get": { "tags": [ "Contracts" ], "summary": "Build entrypoint parameters", "description": "Returns micheline parameters converted from its JSON representation.", "operationId": "Contracts_BuildEntrypointParametersGET", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address", "schema": { "type": "string" }, "x-position": 1 }, { "name": "name", "in": "path", "required": true, "description": "Entrypoint name", "schema": { "type": "string" }, "x-position": 2 }, { "name": "value", "in": "query", "description": "Json parameters", "schema": { "type": "string" }, "x-position": 3 } ], "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } }, "post": { "tags": [ "Contracts" ], "summary": "Build entrypoint parameters", "description": "Returns micheline parameters converted from its JSON representation.", "operationId": "Contracts_BuildEntrypointParametersPOST", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address", "schema": { "type": "string" }, "x-position": 1 }, { "name": "name", "in": "path", "required": true, "description": "Entrypoint name", "schema": { "type": "string" }, "x-position": 2 } ], "requestBody": { "x-name": "value", "description": "Json parameters", "content": { "application/json": { "schema": {} } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/v1/contracts/{address}/storage": { "get": { "tags": [ "Contracts" ], "summary": "Get contract storage", "description": "Returns contract storage value in JSON format.", "operationId": "Contracts_GetStorage", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address", "schema": { "type": "string" }, "x-position": 1 }, { "name": "level", "in": "query", "description": "Level at which storage value should be taken. If `0` or not specified, the current value will be returned.", "schema": { "type": "integer", "format": "int32", "default": 0 }, "x-position": 2 }, { "name": "path", "in": "query", "description": "Path in the JSON value (point-separated list of field names, e.g. `path=settings.refund_time` to return", "schema": { "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/v1/contracts/{address}/storage/schema": { "get": { "tags": [ "Contracts" ], "summary": "Get contract storage schema", "description": "Returns JSON schema of the contract storage.", "operationId": "Contracts_GetStorageSchema", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address", "schema": { "type": "string" }, "x-position": 1 }, { "name": "level", "in": "query", "description": "Level at which storage schema should be taken. If `0` or not specified, the current schema will be returned.", "schema": { "type": "integer", "format": "int32", "default": 0 }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/v1/contracts/{address}/storage/history": { "get": { "tags": [ "Contracts" ], "summary": "Get contract storage history", "description": "Returns contract storage historical values.", "operationId": "Contracts_GetStorageHistory", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address", "schema": { "type": "string" }, "x-position": 1 }, { "name": "lastId", "in": "query", "description": "Id of the last item received (for pagination)", "schema": { "type": "integer", "format": "int32", "default": 0 }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 1000.0, "minimum": 0.0 }, "x-position": 3 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StorageRecord" } } } } } } } }, "/v1/contracts/{address}/storage/raw": { "get": { "tags": [ "Contracts" ], "summary": "Get raw contract storage", "description": "Returns raw contract storage value in micheline format.", "operationId": "Contracts_GetRawStorage", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address", "schema": { "type": "string" }, "x-position": 1 }, { "name": "level", "in": "query", "description": "Level at which storage value should be taken. If `0` or not specified, the current value will be returned.", "schema": { "type": "integer", "format": "int32", "default": 0 }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IMicheline" } } } } } } }, "/v1/contracts/{address}/storage/raw/schema": { "get": { "tags": [ "Contracts" ], "summary": "Get raw contract storage schema", "description": "Returns micheline schema (type) of the contract storage.", "operationId": "Contracts_GetRawStorageSchema", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address", "schema": { "type": "string" }, "x-position": 1 }, { "name": "level", "in": "query", "description": "Level at which storage schema should be taken. If `0` or not specified, the current schema will be returned.", "schema": { "type": "integer", "format": "int32", "default": 0 }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IMicheline" } } } } } } }, "/v1/contracts/{address}/storage/raw/history": { "get": { "tags": [ "Contracts" ], "summary": "Get raw contract storage history", "description": "Returns raw contract storage historical values.", "operationId": "Contracts_GetRawStorageHistory", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address", "schema": { "type": "string" }, "x-position": 1 }, { "name": "lastId", "in": "query", "description": "Id of the last item received (for pagination)", "schema": { "type": "integer", "format": "int32", "default": 0 }, "x-position": 2 }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 10, "maximum": 1000.0, "minimum": 0.0 }, "x-position": 3 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StorageRecord" } } } } } } } }, "/v1/contracts/{address}/bigmaps": { "get": { "tags": [ "Contracts" ], "summary": "Get contract bigmaps", "description": "Returns all active bigmaps allocated in the contract storage.", "operationId": "Contracts_GetBigMaps", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address", "schema": { "type": "string" }, "x-position": 1 }, { "name": "tags", "in": "query", "description": "Filters bigmaps tags (`metadata`, `token_metadata`, `ledger`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BigMapTagsParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "metadata,token_metadata,ledger" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object.\n If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts bigmaps by specified field. Supported fields: `id` (default), `firstLevel`, `lastLevel`, `totalKeys`, `activeKeys`, `updates`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 6 }, { "name": "micheline", "in": "query", "description": "Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 7 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BigMap" } } } } } } } }, "/v1/contracts/{address}/bigmaps/{name}": { "get": { "tags": [ "Contracts" ], "summary": "Get bigmap by name", "description": "Returns contract bigmap with the specified name or storage path.", "operationId": "Contracts_GetBigMapByName", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address", "schema": { "type": "string" }, "x-position": 1 }, { "name": "name", "in": "path", "required": true, "description": "Bigmap name is the last piece of the bigmap storage path.\n For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`.\n If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "micheline", "in": "query", "description": "Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 3 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BigMap" } } } } } } }, "/v1/contracts/{address}/bigmaps/{name}/keys": { "get": { "tags": [ "Contracts" ], "summary": "Get bigmap keys", "description": "Returns keys of a contract bigmap with the specified name.", "operationId": "Contracts_GetBigMapByNameKeys", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address", "schema": { "type": "string" }, "x-position": 1 }, { "name": "name", "in": "path", "required": true, "description": "Bigmap name is the last piece of the bigmap storage path.\n For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`.\n If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "active", "in": "query", "description": "Filters keys by status: `true` - active, `false` - removed.", "schema": { "type": "boolean", "nullable": true }, "x-position": 3 }, { "name": "key", "in": "query", "description": "Filters keys by JSON key. Note, this query parameter supports the following format: `?key{.path?}{.mode?}=...`,\n so you can specify a path to a particular field to filter by, for example: `?key.token_id=...`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonParameter" } ] }, "x-position": 4, "x-tzkt-extension": "json-parameter" }, { "name": "value", "in": "query", "description": "Filters keys by JSON value. Note, this query parameter supports the following format: `?value{.path?}{.mode?}=...`,\n so you can specify a path to a particular field to filter by, for example: `?value.balance.gt=...`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonParameter" } ] }, "x-position": 5, "x-tzkt-extension": "json-parameter" }, { "name": "lastLevel", "in": "query", "description": "Filters bigmap keys by the last update level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts bigmap keys by specified field. Supported fields: `id` (default), `firstLevel`, `lastLevel`, `updates`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 10 }, { "name": "micheline", "in": "query", "description": "Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 11 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BigMapKey" } } } } } } } }, "/v1/contracts/{address}/bigmaps/{name}/keys/{key}": { "get": { "tags": [ "Contracts" ], "summary": "Get bigmap key", "description": "Returns the specified bigmap key.", "operationId": "Contracts_GetKey", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address", "schema": { "type": "string" }, "x-position": 1 }, { "name": "name", "in": "path", "required": true, "description": "Bigmap name is the last piece of the bigmap storage path.\n For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`.\n If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "key", "in": "path", "required": true, "description": "Either a key hash (`expr123...`) or a plain value (`foo...`).\n Even if the key is complex (an object or an array), you can specify it as is, for example, `/keys/{\"address\":\"tz123\",\"nat\":\"123\"}`.", "schema": { "type": "string" }, "x-position": 3 }, { "name": "micheline", "in": "query", "description": "Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 4 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BigMapKey" } } } } } } }, "/v1/contracts/{address}/bigmaps/{name}/keys/{key}/updates": { "get": { "tags": [ "Contracts" ], "summary": "Get bigmap key updates", "description": "Returns updates history for the specified bigmap key.", "operationId": "Contracts_GetKeyUpdates", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address", "schema": { "type": "string" }, "x-position": 1 }, { "name": "name", "in": "path", "required": true, "description": "Bigmap name is the last piece of the bigmap storage path.\n For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`.\n If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "key", "in": "path", "required": true, "description": "Either a key hash (`expr123...`) or a plain value (`foo...`).\n Even if the key is complex (an object or an array), you can specify it as is, for example, `/keys/{\"address\":\"tz123\",\"nat\":\"123\"}`.", "schema": { "type": "string" }, "x-position": 3 }, { "name": "sort", "in": "query", "description": "Sorts bigmap updates by specified field. Supported fields: `id` (default).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 6 }, { "name": "micheline", "in": "query", "description": "Format of the key value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 7 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BigMapKeyUpdate" } } } } } } } }, "/v1/contracts/{address}/bigmaps/{name}/historical_keys/{level}": { "get": { "tags": [ "Contracts" ], "summary": "Get historical keys", "description": "Returns a list of bigmap keys at the specific block.", "operationId": "Contracts_GetHistoricalKeys", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address", "schema": { "type": "string" }, "x-position": 1 }, { "name": "name", "in": "path", "required": true, "description": "Bigmap name is the last piece of the bigmap storage path.\n For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`.\n If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "level", "in": "path", "required": true, "description": "Level of the block at which you want to get bigmap keys", "schema": { "type": "integer", "format": "int32" }, "x-position": 3 }, { "name": "active", "in": "query", "description": "Filters keys by status: `true` - active, `false` - removed.", "schema": { "type": "boolean", "nullable": true }, "x-position": 4 }, { "name": "key", "in": "query", "description": "Filters keys by JSON key. Note, this query parameter supports the following format: `?key{.path?}{.mode?}=...`,\n so you can specify a path to a particular field to filter by, for example: `?key.token_id=...`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonParameter" } ] }, "x-position": 5, "x-tzkt-extension": "json-parameter" }, { "name": "value", "in": "query", "description": "Filters keys by JSON value. Note, this query parameter supports the following format: `?value{.path?}{.mode?}=...`,\n so you can specify a path to a particular field to filter by, for example: `?value.balance.gt=...`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonParameter" } ] }, "x-position": 6, "x-tzkt-extension": "json-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts bigmap keys by specified field. Supported fields: `id` (default).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 10 }, { "name": "micheline", "in": "query", "description": "Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 11 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BigMapKeyHistorical" } } } } } } } }, "/v1/contracts/{address}/bigmaps/{name}/historical_keys/{level}/{key}": { "get": { "tags": [ "Contracts" ], "summary": "Get historical key", "description": "Returns the specified bigmap key at the specific block.", "operationId": "Contracts_GetKey2", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Contract address", "schema": { "type": "string" }, "x-position": 1 }, { "name": "name", "in": "path", "required": true, "description": "Bigmap name is the last piece of the bigmap storage path.\n For example, if the storage path is `ledger` or `assets.ledger`, then the name is `ledger`.\n If there are multiple bigmaps with the same name, for example `assets.ledger` and `tokens.ledger`, you can specify the full path.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "level", "in": "path", "required": true, "description": "Level of the block at which you want to get bigmap key", "schema": { "type": "integer", "format": "int32" }, "x-position": 3 }, { "name": "key", "in": "path", "required": true, "description": "Either a key hash (`expr123...`) or a plain value (`foo...`).\n Even if the key is complex (an object or an array), you can specify it as is, for example, `/keys/{\"address\":\"tz123\",\"nat\":\"123\"}`.", "schema": { "type": "string" }, "x-position": 4 }, { "name": "micheline", "in": "query", "description": "Format of the bigmap key and value: `0` - JSON, `1` - JSON string, `2` - Micheline, `3` - Micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 5 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BigMapKeyHistorical" } } } } } } }, "/v1/cycles/count": { "get": { "tags": [ "Cycles" ], "summary": "Get cycles count", "description": "Returns the total number of cycles, including future cycles.", "operationId": "Cycles_GetCount", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/cycles": { "get": { "tags": [ "Cycles" ], "summary": "Get cycles", "description": "Returns a list of cycles, including future cycles.", "operationId": "Cycles_Get", "parameters": [ { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts cycles by specified field. Supported fields: `index` (default, desc).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 4 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 5 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Cycle" } } } } } } } }, "/v1/cycles/{index}": { "get": { "tags": [ "Cycles" ], "summary": "Get cycle by index", "description": "Returns a cycle at the specified index.", "operationId": "Cycles_GetByIndex", "parameters": [ { "name": "index", "in": "path", "required": true, "description": "Cycle index starting from zero", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cycle" } } } } } } }, "/v1/delegates": { "get": { "tags": [ "Delegates" ], "summary": "Get delegates", "description": "Returns a list of delegate accounts.", "operationId": "Delegates_Get", "parameters": [ { "name": "active", "in": "query", "description": "Delegate status to filter by (true - only active, false - only deactivated, undefined - all delegates)", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BoolParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "lastActivity", "in": "query", "description": "Filters delegates by last activity level (where the delegate was updated)", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts delegators by specified field. Supported fields: `id` (default), `stakedBalance`, `externalStakedBalance`, `ownDelegatedBalance`, `externalDelegatedBalance`, `bakingPower`, `votingPower`, `balance`, `numDelegators`, `stakersCount`, `activationLevel`, `deactivationLevel`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 6 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Delegate" } } } } } } } }, "/v1/delegates/count": { "get": { "tags": [ "Delegates" ], "summary": "Get delegates count", "description": "Returns a number of delegate accounts.", "operationId": "Delegates_GetCount", "parameters": [ { "name": "active", "in": "query", "description": "Delegate status to filter by (true - only active, false - only deactivated, undefined - all delegates)", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BoolParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/delegates/{address}": { "get": { "tags": [ "Delegates" ], "summary": "Get delegate by address", "description": "Returns a delegate with the specified address.", "operationId": "Delegates_GetByAddress", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Delegate address (starting with tz)", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Delegate" } } } } } } }, "/v1/domains/count": { "get": { "tags": [ "Domains" ], "summary": "Get domains count", "description": "Returns the total number of domains.", "operationId": "Domains_GetCount", "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/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \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": "name", "in": "query", "description": "Filter by the domain name. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/StringParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "owner", "in": "query", "description": "Filter by the domain owner. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AddressNullParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "address", "in": "query", "description": "Filter by the address the domain points to. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AddressNullParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "reverse", "in": "query", "description": "Filter by the 'reverse' flag. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BoolParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "expiration", "in": "query", "description": "Filter by the domain expiration. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DateTimeParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "data", "in": "query", "description": "Filter by the domain data. \nNote, this parameter supports the following format: `data{.path?}{.mode?}=...`,\nso you can specify a path to a particular field to filter by (for example, `?data.foo=bar`). \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": "firstLevel", "in": "query", "description": "Filter by level of the block where the domain was first seen. \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 domain was first seen. \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 domain 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 domain was last seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 12, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/domains": { "get": { "tags": [ "Domains" ], "summary": "Get domains", "description": "Returns a list of domains.", "operationId": "Domains_Get", "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/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \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": "name", "in": "query", "description": "Filter by the domain name. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/StringParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "owner", "in": "query", "description": "Filter by the domain owner. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AddressNullParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "address", "in": "query", "description": "Filter by the address the domain points to. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AddressNullParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "reverse", "in": "query", "description": "Filter by the 'reverse' flag. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BoolParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "expiration", "in": "query", "description": "Filter by the domain expiration. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DateTimeParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "data", "in": "query", "description": "Filter by the domain data. \nNote, this parameter supports the following format: `data{.path?}{.mode?}=...`,\nso you can specify a path to a particular field to filter by (for example, `?data.foo=bar`). \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": "firstLevel", "in": "query", "description": "Filter by level of the block where the domain was first seen. \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 domain was first seen. \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 domain 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 domain was last seen. \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": "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": 13, "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": 14, "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": 15 }, { "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": 16, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Domain" } } } } } } } }, "/v1/domains/{name}": { "get": { "tags": [ "Domains" ], "summary": "Get domain by name", "description": "Returns the domain with the specified name.", "operationId": "Domains_GetByName", "parameters": [ { "name": "name", "in": "path", "required": true, "description": "Domain name", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain" } } } } } } }, "/v1/contracts/events/count": { "get": { "tags": [ "Events" ], "summary": "Get contract events count", "description": "Returns a total number of contract events.", "operationId": "Events_GetContractEventsCount", "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/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by level of the block where the event was emitted. \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 event was emitted. \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": "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": "codeHash", "in": "query", "description": "Filter by hash of the code of the contract emitted the event. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "tag", "in": "query", "description": "Filter by event tag. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/StringParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "payload", "in": "query", "description": "Filter by payload. \nNote, this parameter supports the following format: `payload{.path?}{.mode?}=...`,\nso you can specify a path to a particular field to filter by (for example, `?payload.foo.bar.in=1,2,3`). \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": "transactionId", "in": "query", "description": "Filter by id of the transaction, in which the event was emitted. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/contracts/events": { "get": { "tags": [ "Events" ], "summary": "Get contract events", "description": "Returns a list of contract events.", "operationId": "Events_GetContractEvents", "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/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by level of the block where the event was emitted. \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 event was emitted. \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": "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": "codeHash", "in": "query", "description": "Filter by hash of the code of the contract emitted the event. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "tag", "in": "query", "description": "Filter by event tag. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/StringParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "payload", "in": "query", "description": "Filter by payload. \nNote, this parameter supports the following format: `payload{.path?}{.mode?}=...`,\nso you can specify a path to a particular field to filter by (for example, `?payload.foo.bar.in=1,2,3`). \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": "transactionId", "in": "query", "description": "Filter by id of the transaction, in which the event was emitted. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "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/ContractEvent" } } } } } } } }, "/v1/head": { "get": { "tags": [ "Head" ], "summary": "Get indexer head", "description": "Returns indexer head and synchronization status.", "operationId": "Head_Get", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/State" } } } } } } }, "/v1/helpers/inject": { "post": { "tags": [ "Helpers" ], "summary": "Inject operation", "description": "Injects signed operation to the blockchain and returns the operation hash.", "operationId": "Helpers_PostInject", "parameters": [ { "name": "async", "in": "query", "description": "If `true`, the function returns immediately. Otherwise, the operation will be validated before the result is returned.", "schema": { "type": "boolean", "default": true }, "x-position": 2 } ], "requestBody": { "x-name": "bytes", "description": "Forged operation bytes + signature in hex format.", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/v1/helpers/view/{contract}/{name}": { "post": { "tags": [ "Helpers" ], "summary": "Run script view", "description": "Simulate a call to a michelson view", "operationId": "Helpers_PostRunScriptView", "parameters": [ { "name": "contract", "in": "path", "required": true, "description": "Contract address", "schema": { "type": "string" }, "x-position": 1 }, { "name": "name", "in": "path", "required": true, "description": "View name", "schema": { "type": "string" }, "x-position": 2 } ], "requestBody": { "x-name": "input", "description": "Input to be passed to the contract view (in human-readable format, see \"Json schema\" on tzkt.io)", "content": { "application/json": { "schema": {} } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/v1/operations/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get operations by hash", "description": "Returns a list of operations with the specified hash. \n**NOTE: if you know in advance what operation type you want to get (e.g. transactions), prefer using `/v1/operations/{type}/{hash}`\n(e.g. [/v1/operations/transactions/{hash}](#operation/Operations_GetTransactionByHash)) instead, because it's much more efficient.**", "operationId": "Operations_GetByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "micheline", "in": "query", "description": "Format of the parameters, storage and diffs: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 2 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 3 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } } } } }, "/v1/operations/{hash}/{counter}": { "get": { "tags": [ "Operations" ], "summary": "Get operations by hash and counter", "description": "Returns a list of operations with the specified hash and counter. \n**NOTE: if you know in advance what operation type you want to get (e.g. transactions), prefer using `/v1/operations/{type}/{hash}/{counter}`\n(e.g. [/v1/operations/transactions/{hash}/{counter}](#operation/Operations_GetTransactionByHashCounter)) instead, because it's much more efficient.**", "operationId": "Operations_GetByHashCounter", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "counter", "in": "path", "required": true, "description": "Operation counter", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "micheline", "in": "query", "description": "Format of the parameters, storage and diffs: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 3 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 4 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } } } } }, "/v1/operations/{hash}/{counter}/{nonce}": { "get": { "tags": [ "Operations" ], "summary": "Get operations by hash, counter and nonce", "description": "Returns an internal operations with the specified hash, counter and nonce. \n**NOTE: if you know in advance what operation type you want to get (e.g. transactions), prefer using `/v1/operations/{type}/{hash}/{counter}/{nonce}`\n(e.g. [/v1/operations/transactions/{hash}/{counter}/{nonce}](#operation/Operations_GetTransactionByHashCounterNonce)) instead, because it's much more efficient.**", "operationId": "Operations_GetByHashCounterNonce", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "counter", "in": "path", "required": true, "description": "Operation counter", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "nonce", "in": "path", "required": true, "description": "Operation nonce (internal)", "schema": { "type": "integer", "format": "int32" }, "x-position": 3 }, { "name": "micheline", "in": "query", "description": "Format of the parameters, storage and diffs: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 4 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 5 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } } } } }, "/v1/operations/{hash}/status": { "get": { "tags": [ "Operations" ], "summary": "Get operation status", "description": "Returns operation status: `true` if applied, `false` if failed, `null` (or HTTP 204) if doesn't exist. \n**NOTE: if you know in advance what operation type you want to check (e.g. transactions), prefer using `/v1/operations/{type}/{hash}/status`\n(e.g. [/v1/operations/transactions/{hash}/status](#operation/Operations_GetTransactionStatus)) instead, because it's much more efficient.**", "operationId": "Operations_GetStatus", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean", "nullable": true } } } } } } }, "/v1/operations/attestations": { "get": { "tags": [ "Operations" ], "summary": "Get attestations", "description": "Returns a list of attestation operations.", "operationId": "Operations_GetAttestations", "parameters": [ { "name": "delegate", "in": "query", "description": "Filters attestations by delegate. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "id", "in": "query", "description": "Filters operations by internal TzKT id.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters attestations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters attestations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts attestations by specified field. Supported fields: `id` (default), `level`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 8 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 9 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttestationOperation" } } } } } } } }, "/v1/operations/attestations/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get attestation by hash", "description": "Returns an attestation operation with specified hash.", "operationId": "Operations_GetAttestationByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttestationOperation" } } } } } } } }, "/v1/operations/attestations/count": { "get": { "tags": [ "Operations" ], "summary": "Get attestations count", "description": "Returns the total number of attestation operations.", "operationId": "Operations_GetAttestationsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters attestations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters attestations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } } } } } }, "/v1/operations/preattestations": { "get": { "tags": [ "Operations" ], "summary": "Get preattestations", "description": "Returns a list of preattestation operations.", "operationId": "Operations_GetPreattestations", "parameters": [ { "name": "delegate", "in": "query", "description": "Filters by delegate. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts by specified field. Supported fields: `id` (default), `level`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 7 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 8 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PreattestationOperation" } } } } } } } }, "/v1/operations/preattestations/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get preattestation by hash", "description": "Returns an preattestation operation with specified hash.", "operationId": "Operations_GetPreattestationByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PreattestationOperation" } } } } } } } }, "/v1/operations/preattestations/count": { "get": { "tags": [ "Operations" ], "summary": "Get preattestations count", "description": "Returns the total number of preattestation operations.", "operationId": "Operations_GetPreattestationsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/ballots": { "get": { "tags": [ "Operations" ], "summary": "Get ballots", "description": "Returns a list of ballot operations.", "operationId": "Operations_GetBallots", "parameters": [ { "name": "delegate", "in": "query", "description": "Filters ballots by delegate. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters ballots by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters ballots by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "epoch", "in": "query", "description": "Filters ballots by voting epoch.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "period", "in": "query", "description": "Filters ballots by voting period.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "proposal", "in": "query", "description": "Filters ballots by proposal hash.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ProtocolParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "vote", "in": "query", "description": "Filters ballots by vote (`yay`, `nay`, `pass`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VoteParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "yay,nay,pass" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts ballots by specified field. Supported fields: `id` (default), `level`.", "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", "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", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 11 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 12 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BallotOperation" } } } } } } } }, "/v1/operations/ballots/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get ballot by hash", "description": "Returns a ballot operation with specified hash.", "operationId": "Operations_GetBallotByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BallotOperation" } } } } } } } }, "/v1/operations/ballots/count": { "get": { "tags": [ "Operations" ], "summary": "Get ballots count", "description": "Returns the total number of ballot operations.", "operationId": "Operations_GetBallotsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters ballot operations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters ballot operations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/proposals": { "get": { "tags": [ "Operations" ], "summary": "Get proposals", "description": "Returns a list of proposal operations.", "operationId": "Operations_GetProposals", "parameters": [ { "name": "delegate", "in": "query", "description": "Filters proposal operations by delegate. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters proposal operations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters proposal operations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "epoch", "in": "query", "description": "Filters proposal operations by voting epoch.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "period", "in": "query", "description": "Filters proposal operations by voting period.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "proposal", "in": "query", "description": "Filters proposal operations by proposal hash.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ProtocolParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "duplicated", "in": "query", "description": "Specify whether to include or exclude duplicates, which didn't actually upvote a proposal.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BoolParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts proposal operations by specified field. Supported fields: `id` (default), `level`.", "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", "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", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 11 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 12 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProposalOperation" } } } } } } } }, "/v1/operations/proposals/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get proposal by hash", "description": "Returns a proposal operation with specified hash.", "operationId": "Operations_GetProposalByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProposalOperation" } } } } } } } }, "/v1/operations/proposals/count": { "get": { "tags": [ "Operations" ], "summary": "Get proposals count", "description": "Returns the total number of proposal operations.", "operationId": "Operations_GetProposalsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters proposal operations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters proposal operations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/activations": { "get": { "tags": [ "Operations" ], "summary": "Get activations", "description": "Returns a list of activation operations.", "operationId": "Operations_GetActivations", "parameters": [ { "name": "account", "in": "query", "description": "Filters activations by account. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters activations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters activations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts activations by specified field. Supported fields: `id` (default), `level`, `balance`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 7 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 8 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivationOperation" } } } } } } } }, "/v1/operations/activations/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get activation by hash", "description": "Returns an activation operation with specified hash.", "operationId": "Operations_GetActivationByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivationOperation" } } } } } } } }, "/v1/operations/activations/count": { "get": { "tags": [ "Operations" ], "summary": "Get activations count", "description": "Returns the total number of activation operations.", "operationId": "Operations_GetActivationsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters activations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters activations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/dal_entrapment_evidence": { "get": { "tags": [ "Operations" ], "summary": "Get dal entrapment evidences", "description": "Returns a list of dal entrapment evidence operations.", "operationId": "Operations_GetDalEntrapmentEvidenceOps", "parameters": [ { "name": "anyof", "in": "query", "description": "Filters by any of the specified fields. Example: `anyof.accuser.offender=tz1...` will return operations where `accuser` OR `offender` is equal to the specified value. This parameter is useful when you need to retrieve all operations associated with a specified account.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AnyOfParameter" } ] }, "x-position": 1, "x-tzkt-extension": "anyof-parameter", "x-tzkt-anyof-parameter": "accuser,offender" }, { "name": "accuser", "in": "query", "description": "Filters by accuser. Allowed fields for `.eqx` mode: `offender`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "offender", "in": "query", "description": "Filters by offender. Allowed fields for `.eqx` mode: `accuser`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "id", "in": "query", "description": "Filters operations by internal TzKT id.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts by specified field. Supported fields: `id` (default), `level`, `trapLevel`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 10 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 11 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DalEntrapmentEvidenceOperation" } } } } } } } }, "/v1/operations/dal_entrapment_evidence/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get dal entrapment evidence by hash", "description": "Returns dal entrapment evidence operations with specified hash.", "operationId": "Operations_GetDalEntrapmentEvidenceOpsByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DalEntrapmentEvidenceOperation" } } } } } } } }, "/v1/operations/dal_entrapment_evidence/count": { "get": { "tags": [ "Operations" ], "summary": "Get dal entrapment evidences count", "description": "Returns the total number of dal entrapment evidence operations.", "operationId": "Operations_GetDalEntrapmentEvidenceOpsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/double_baking": { "get": { "tags": [ "Operations" ], "summary": "Get double baking", "description": "Returns a list of double baking operations.", "operationId": "Operations_GetDoubleBaking", "parameters": [ { "name": "anyof", "in": "query", "description": "Filters double baking operations by any of the specified fields. Example: `anyof.accuser.offender=tz1...` will return operations where `accuser` OR `offender` is equal to the specified value. This parameter is useful when you need to retrieve all operations associated with a specified account.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AnyOfParameter" } ] }, "x-position": 1, "x-tzkt-extension": "anyof-parameter", "x-tzkt-anyof-parameter": "accuser,offender" }, { "name": "accuser", "in": "query", "description": "Filters double baking operations by accuser. Allowed fields for `.eqx` mode: `offender`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "offender", "in": "query", "description": "Filters double baking operations by offender. Allowed fields for `.eqx` mode: `accuser`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "id", "in": "query", "description": "Filters operations by internal TzKT id.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters double baking operations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters double baking operations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts double baking operations by specified field. Supported fields: `id` (default), `level`, `accusedLevel`, `accuserRewards`, `offenderLostDeposits`, `offenderLostRewards`, `offenderLostFees`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 10 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 11 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DoubleBakingOperation" } } } } } } } }, "/v1/operations/double_baking/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get double baking by hash", "description": "Returns a double baking operation with specified hash.", "operationId": "Operations_GetDoubleBakingByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DoubleBakingOperation" } } } } } } } }, "/v1/operations/double_baking/count": { "get": { "tags": [ "Operations" ], "summary": "Get double baking count", "description": "Returns the total number of double baking operations.", "operationId": "Operations_GetDoubleBakingCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters double baking operations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters double baking operations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/double_consensus": { "get": { "tags": [ "Operations" ], "summary": "Get double consensus", "description": "Returns a list of double consensus operations.", "operationId": "Operations_GetDoubleConsensus", "parameters": [ { "name": "anyof", "in": "query", "description": "Filter by any of the specified fields. Example: `anyof.accuser.offender=tz1...` will return operations where `accuser` OR `offender` is equal to the specified value. This parameter is useful when you need to retrieve all operations associated with a specified account.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AnyOfParameter" } ] }, "x-position": 1, "x-tzkt-extension": "anyof-parameter", "x-tzkt-anyof-parameter": "accuser,offender" }, { "name": "accuser", "in": "query", "description": "Filter by accuser. Allowed fields for `.eqx` mode: `offender`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "offender", "in": "query", "description": "Filter by offender. Allowed fields for `.eqx` mode: `accuser`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "id", "in": "query", "description": "Filter by internal TzKT id.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "kind", "in": "query", "description": "Filter by misbehaviour kind (`double_attestation` or `double_preattestation`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DoubleConsensusKindParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "double_attestation,double_preattestation" }, { "name": "level", "in": "query", "description": "Filter by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sort by specified field. Supported fields: `id` (default), `level`, `accusedLevel`, `accuserRewards`, `offenderLostDeposits`, `offenderLostRewards`, `offenderLostFees`.", "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", "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", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 11 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 12 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DoubleConsensusOperation" } } } } } } } }, "/v1/operations/double_consensus/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get double consensus by hash", "description": "Returns a double consensus operation with specified hash.", "operationId": "Operations_GetDoubleConsensusByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DoubleConsensusOperation" } } } } } } } }, "/v1/operations/double_consensus/count": { "get": { "tags": [ "Operations" ], "summary": "Get double consensus count", "description": "Returns the total number of double consensus operations.", "operationId": "Operations_GetDoubleConsensusCount", "parameters": [ { "name": "kind", "in": "query", "description": "Filter by misbehaviour kind (`double_attestation` or `double_preattestation`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DoubleConsensusKindParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "double_attestation,double_preattestation" }, { "name": "level", "in": "query", "description": "Filter by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/nonce_revelations": { "get": { "tags": [ "Operations" ], "summary": "Get nonce revelations", "description": "Returns a list of seed nonce revelation operations.", "operationId": "Operations_GetNonceRevelations", "parameters": [ { "name": "anyof", "in": "query", "description": "Filters nonce revelation operations by any of the specified fields. Example: `anyof.baker.sender=tz1...` will return operations where `baker` OR `sender` is equal to the specified value. This parameter is useful when you need to retrieve all operations associated with a specified account.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AnyOfParameter" } ] }, "x-position": 1, "x-tzkt-extension": "anyof-parameter", "x-tzkt-anyof-parameter": "baker,sender" }, { "name": "baker", "in": "query", "description": "Filters nonce revelation operations by baker. Allowed fields for `.eqx` mode: `sender`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "sender", "in": "query", "description": "Filters nonce revelation operations by sender. Allowed fields for `.eqx` mode: `baker`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "id", "in": "query", "description": "Filters operations by internal TzKT id.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters nonce revelation operations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "revealedCycle", "in": "query", "description": "Filters by cycle for which the nonce was revealed.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters nonce revelation operations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts nonce revelation operations by specified field. Supported fields: `id` (default), `level`, `revealedLevel`.", "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", "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", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 11 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 12 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NonceRevelationOperation" } } } } } } } }, "/v1/operations/nonce_revelations/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get nonce revelation by hash", "description": "Returns a seed nonce revelation operation with specified hash.", "operationId": "Operations_GetNonceRevelationByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NonceRevelationOperation" } } } } } } } }, "/v1/operations/nonce_revelations/count": { "get": { "tags": [ "Operations" ], "summary": "Get nonce revelations count", "description": "Returns the total number of seed nonce revelation operations.", "operationId": "Operations_GetNonceRevelationsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters seed nonce revelation operations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters seed nonce revelation operations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/vdf_revelations": { "get": { "tags": [ "Operations" ], "summary": "Get vdf revelations", "description": "Returns a list of vdf revelation operations.", "operationId": "Operations_GetVdfRevelations", "parameters": [ { "name": "baker", "in": "query", "description": "Filters by baker. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "id", "in": "query", "description": "Filters operations by internal TzKT id.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "cycle", "in": "query", "description": "Filters by cycle in which the operation was included.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts by specified field. Supported fields: `id` (default), `level`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 9 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 10 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VdfRevelationOperation" } } } } } } } }, "/v1/operations/vdf_revelations/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get vdf revelation by hash", "description": "Returns a vdf revelation operation with specified hash.", "operationId": "Operations_GetVdfRevelationByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VdfRevelationOperation" } } } } } } } }, "/v1/operations/vdf_revelations/count": { "get": { "tags": [ "Operations" ], "summary": "Get vdf revelations count", "description": "Returns the total number of vdf revelation operations.", "operationId": "Operations_GetVdfRevelationsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/drain_delegate": { "get": { "tags": [ "Operations" ], "summary": "Get drain delegate", "description": "Returns a list of drain delegate operations.", "operationId": "Operations_GetDrainDelegateOps", "parameters": [ { "name": "anyof", "in": "query", "description": "Filters by any of the specified fields. Example: `anyof.delegate.target=tz1...` will return operations where `delegate` OR `target` is equal to the specified value. This parameter is useful when you need to retrieve all operations associated with a specified account.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AnyOfParameter" } ] }, "x-position": 1, "x-tzkt-extension": "anyof-parameter", "x-tzkt-anyof-parameter": "delegate,target" }, { "name": "delegate", "in": "query", "description": "Filters by drained baker. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "target", "in": "query", "description": "Filters by target. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts by specified field. Supported fields: `id` (default), `level`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 9 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 10 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DrainDelegateOperation" } } } } } } } }, "/v1/operations/drain_delegate/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get drain delegate by hash", "description": "Returns a drain delegate operation with specified hash.", "operationId": "Operations_GetDrainDelegateByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DrainDelegateOperation" } } } } } } } }, "/v1/operations/drain_delegate/count": { "get": { "tags": [ "Operations" ], "summary": "Get drain delegate count", "description": "Returns the total number of drain delegate operations.", "operationId": "Operations_GetDrainDelegateOpsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/delegations": { "get": { "tags": [ "Operations" ], "summary": "Get delegations", "description": "Returns a list of delegation operations.", "operationId": "Operations_GetDelegations", "parameters": [ { "name": "anyof", "in": "query", "description": "Filters delegations by any of the specified fields. Example: `anyof.prevDelegate.newDelegate=tz1...` will return operations where `prevDelegate` OR `newDelegate` is equal to the specified value. This parameter is useful when you need to retrieve all delegations associated with a specified account.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AnyOfParameter" } ] }, "x-position": 1, "x-tzkt-extension": "anyof-parameter", "x-tzkt-anyof-parameter": "sender,prevDelegate,newDelegate" }, { "name": "initiator", "in": "query", "description": "Filters delegations by initiator. Allowed fields for `.eqx` mode: `prevDelegate`, `newDelegate`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "sender", "in": "query", "description": "Filters delegations by sender. Allowed fields for `.eqx` mode: `prevDelegate`, `newDelegate`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "prevDelegate", "in": "query", "description": "Filters delegations by prev delegate. Allowed fields for `.eqx` mode: `initiator`, `sender`, `newDelegate`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "newDelegate", "in": "query", "description": "Filters delegations by new delegate. Allowed fields for `.eqx` mode: `initiator`, `sender`, `prevDelegate`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "id", "in": "query", "description": "Filters operations by internal TzKT id.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters delegations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters delegations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "senderCodeHash", "in": "query", "description": "Filters by `senderCodeHash`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filters delegations by operation status (`applied`, `failed`, `backtracked`, `skipped`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 10, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 11, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts delegations by specified field. Supported fields: `id` (default), `level`, `gasUsed`, `bakerFee`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 12, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 13, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 14 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 15 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DelegationOperation" } } } } } } } }, "/v1/operations/delegations/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get delegation by hash", "description": "Returns a delegation operation with specified hash.", "operationId": "Operations_GetDelegationByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DelegationOperation" } } } } } } } }, "/v1/operations/delegations/{hash}/status": { "get": { "tags": [ "Operations" ], "summary": "Get delegation status", "description": "Returns operation status: `true` if applied, `false` if failed, `null` (or HTTP 204) if doesn't exist.", "operationId": "Operations_GetDelegationStatus", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean", "nullable": true } } } } } } }, "/v1/operations/delegations/count": { "get": { "tags": [ "Operations" ], "summary": "Get delegations count", "description": "Returns the total number of delegation operations.", "operationId": "Operations_GetDelegationsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters delegations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters delegations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/originations": { "get": { "tags": [ "Operations" ], "summary": "Get originations", "description": "Returns a list of origination operations.", "operationId": "Operations_GetOriginations", "parameters": [ { "name": "anyof", "in": "query", "description": "Filters originations by any of the specified fields. Example: `anyof.sender.initiator=tz1...` will return operations where `sender` OR `initiator` is equal to the specified value. This parameter is useful when you need to retrieve all originations associated with a specified account.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AnyOfParameter" } ] }, "x-position": 1, "x-tzkt-extension": "anyof-parameter", "x-tzkt-anyof-parameter": "initiator,sender,contractDelegate,originatedContract" }, { "name": "initiator", "in": "query", "description": "Filters origination operations by initiator. Allowed fields for `.eqx` mode: `contractDelegate`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "sender", "in": "query", "description": "Filters origination operations by sender. Allowed fields for `.eqx` mode: `contractDelegate`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "contractDelegate", "in": "query", "description": "Filters origination operations by delegate. Allowed fields for `.eqx` mode: `initiator`, `sender`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "originatedContract", "in": "query", "description": "Filters origination operations by originated contract. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "id", "in": "query", "description": "Filters origination operations by internal TzKT id", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "typeHash", "in": "query", "description": "Filters origination operations by 32-bit hash of originated contract parameter and storage types (helpful for searching originations of similar contracts)", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "codeHash", "in": "query", "description": "Filters origination operations by 32-bit hash of originated contract code (helpful for searching originations of same contracts)", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters origination operations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters origination operations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 10, "x-tzkt-extension": "query-parameter" }, { "name": "senderCodeHash", "in": "query", "description": "Filters by `senderCodeHash`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 11, "x-tzkt-extension": "query-parameter" }, { "name": "anyCodeHash", "in": "query", "description": "Filters by either `senderCodeHash` or `codeHash`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 12, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filters origination operations by operation status (`applied`, `failed`, `backtracked`, `skipped`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 13, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 14, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts originations by specified field. Supported fields: `id` (default), `level`, `gasUsed`, `storageUsed`, `bakerFee`, `storageFee`, `allocationFee`, `contractBalance`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 15, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 16, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 17 }, { "name": "micheline", "in": "query", "description": "Format of the parameters, storage and diffs: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 18 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 19 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OriginationOperation" } } } } } } } }, "/v1/operations/originations/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get origination by hash", "description": "Returns origination operations with specified hash.", "operationId": "Operations_GetOriginationByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "micheline", "in": "query", "description": "Format of the parameters, storage and diffs: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string", "schema": { "$ref": "#/components/schemas/MichelineFormat" }, "x-position": 2 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 3 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OriginationOperation" } } } } } } } }, "/v1/operations/originations/{hash}/status": { "get": { "tags": [ "Operations" ], "summary": "Get origination status", "description": "Returns operation status: `true` if applied, `false` if failed, `null` (or HTTP 204) if doesn't exist.", "operationId": "Operations_GetOriginationStatus", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean", "nullable": true } } } } } } }, "/v1/operations/originations/count": { "get": { "tags": [ "Operations" ], "summary": "Get originations count", "description": "Returns the total number of origination operations.", "operationId": "Operations_GetOriginationsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters originations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters originations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/transactions": { "get": { "tags": [ "Operations" ], "summary": "Get transactions", "description": "Returns a list of transaction operations.", "operationId": "Operations_GetTransactions", "parameters": [ { "name": "anyof", "in": "query", "description": "Filters transactions by any of the specified fields. Example: `anyof.sender.target=tz1...` will return operations where `sender` OR `target` is equal to the specified value. This parameter is useful when you need to retrieve all transactions associated with a specified account.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AnyOfParameter" } ] }, "x-position": 1, "x-tzkt-extension": "anyof-parameter", "x-tzkt-anyof-parameter": "sender,target,initiator" }, { "name": "initiator", "in": "query", "description": "Filters transactions by initiator. Allowed fields for `.eqx` mode: `target`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "sender", "in": "query", "description": "Filters transactions by sender. Allowed fields for `.eqx` mode: `target`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "target", "in": "query", "description": "Filters transactions by target. Allowed fields for `.eqx` mode: `sender`, `initiator`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "amount", "in": "query", "description": "Filters transactions by amount (micro tez).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "id", "in": "query", "description": "Filters transactions by id.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters transactions by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters transactions by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "senderCodeHash", "in": "query", "description": "Filters by `senderCodeHash`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "targetCodeHash", "in": "query", "description": "Filters by `targetCodeHash`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 10, "x-tzkt-extension": "query-parameter" }, { "name": "codeHash", "in": "query", "description": "Filters by either `senderCodeHash` or `targetCodeHash`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 11, "x-tzkt-extension": "query-parameter" }, { "name": "entrypoint", "in": "query", "description": "Filters transactions by entrypoint called on the target contract.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/StringParameter" } ] }, "x-position": 12, "x-tzkt-extension": "query-parameter" }, { "name": "parameter", "in": "query", "description": "Filters transactions by parameter value. Note, this query parameter supports the following format: `?parameter{.path?}{.mode?}=...`,\n so you can specify a path to a particular field to filter by, for example: `?parameter.token_id=...` or `?parameter.sigs.0.ne=...`.\n Also, note that `.value` part must be omitted in the path, so, for example, filtering by `parameter.value.foo` must be specified as `?parameter.foo=...`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonParameter" } ] }, "x-position": 13, "x-tzkt-extension": "json-parameter" }, { "name": "hasInternals", "in": "query", "description": "Filters transactions by presence of internal operations.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BoolParameter" } ] }, "x-position": 14, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filters transactions by operation status (`applied`, `failed`, `backtracked`, `skipped`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 15, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 16, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts transactions by specified field. Supported fields: `id` (default), `level`, `gasUsed`, `storageUsed`, `bakerFee`, `storageFee`, `allocationFee`, `amount`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 17, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 18, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 19 }, { "name": "micheline", "in": "query", "description": "Format of the parameters, storage and diffs: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 20 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 21 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionOperation" } } } } } } } }, "/v1/operations/transactions/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get transaction by hash", "description": "Returns transaction operations with specified hash.", "operationId": "Operations_GetTransactionByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "micheline", "in": "query", "description": "Format of the parameters, storage and diffs: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 2 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 3 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionOperation" } } } } } } } }, "/v1/operations/transactions/{hash}/{counter}": { "get": { "tags": [ "Operations" ], "summary": "Get transaction by hash and counter", "description": "Returns transaction operations with specified hash and counter.", "operationId": "Operations_GetTransactionByHashCounter", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "counter", "in": "path", "required": true, "description": "Operation counter", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "micheline", "in": "query", "description": "Format of the parameters, storage and diffs: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 3 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 4 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionOperation" } } } } } } } }, "/v1/operations/transactions/{hash}/{counter}/{nonce}": { "get": { "tags": [ "Operations" ], "summary": "Get transaction by hash, counter and nonce", "description": "Returns an internal transaction operation with specified hash, counter and nonce.", "operationId": "Operations_GetTransactionByHashCounterNonce", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "counter", "in": "path", "required": true, "description": "Operation counter", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "nonce", "in": "path", "required": true, "description": "Operation nonce (internal)", "schema": { "type": "integer", "format": "int32" }, "x-position": 3 }, { "name": "micheline", "in": "query", "description": "Format of the parameters, storage and diffs: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 4 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 5 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionOperation" } } } } } } } }, "/v1/operations/transactions/{hash}/status": { "get": { "tags": [ "Operations" ], "summary": "Get transaction status", "description": "Returns operation status: `true` if applied, `false` if failed, `null` (or HTTP 204) if doesn't exist.", "operationId": "Operations_GetTransactionStatus", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean", "nullable": true } } } } } } }, "/v1/operations/transactions/count": { "get": { "tags": [ "Operations" ], "summary": "Get transactions count", "description": "Returns the total number of transaction operations.", "operationId": "Operations_GetTransactionsCount", "parameters": [ { "name": "anyof", "in": "query", "description": "Filters transactions by any of the specified fields. Example: `anyof.sender.target=tz1...` will return operations where `sender` OR `target` is equal to the specified value. This parameter is useful when you need to retrieve all transactions associated with a specified account.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AnyOfParameter" } ] }, "x-position": 1, "x-tzkt-extension": "anyof-parameter", "x-tzkt-anyof-parameter": "sender,target,initiator" }, { "name": "initiator", "in": "query", "description": "Filters transactions by initiator. Allowed fields for `.eqx` mode: `target`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "sender", "in": "query", "description": "Filters transactions by sender. Allowed fields for `.eqx` mode: `target`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "target", "in": "query", "description": "Filters transactions by target. Allowed fields for `.eqx` mode: `sender`, `initiator`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "amount", "in": "query", "description": "Filters transactions by amount (micro tez).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters transactions by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters transactions by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "entrypoint", "in": "query", "description": "Filters transactions by entrypoint called on the target contract.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/StringParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "parameter", "in": "query", "description": "Filters transactions by parameter value. Note, this query parameter supports the following format: `?parameter{.path?}{.mode?}=...`,\n so you can specify a path to a particular field to filter by, for example: `?parameter.token_id=...` or `?parameter.sigs.0.ne=...`.\n Also, note that `.value` part must be omitted in the path, so, for example, filtering by `parameter.value.foo` must be specified as `?parameter.foo=...`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonParameter" } ] }, "x-position": 9, "x-tzkt-extension": "json-parameter" }, { "name": "status", "in": "query", "description": "Filters transactions by operation status (`applied`, `failed`, `backtracked`, `skipped`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 10, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/reveals": { "get": { "tags": [ "Operations" ], "summary": "Get reveals", "description": "Returns a list of reveal operations.", "operationId": "Operations_GetReveals", "parameters": [ { "name": "sender", "in": "query", "description": "Filters reveal operations by sender. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters reveal operations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters reveal operations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filters reveal operations by operation status (`applied`, `failed`, `backtracked`, `skipped`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts reveals by specified field. Supported fields: `id` (default), `level`, `gasUsed`, `bakerFee`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 8 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 9 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RevealOperation" } } } } } } } }, "/v1/operations/reveals/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get reveal by hash", "description": "Returns reveal operation with specified hash.", "operationId": "Operations_GetRevealByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RevealOperation" } } } } } } } }, "/v1/operations/reveals/{hash}/status": { "get": { "tags": [ "Operations" ], "summary": "Get reveal status", "description": "Returns operation status: `true` if applied, `false` if failed, `null` (or HTTP 204) if doesn't exist.", "operationId": "Operations_GetRevealStatus", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean", "nullable": true } } } } } } }, "/v1/operations/reveals/count": { "get": { "tags": [ "Operations" ], "summary": "Get reveals count", "description": "Returns the total number of reveal operations.", "operationId": "Operations_GetRevealsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters reveals by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters reveals by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/register_constants": { "get": { "tags": [ "Operations" ], "summary": "Get register constants", "description": "Returns a list of register global constant operations.", "operationId": "Operations_GetRegisterConstants", "parameters": [ { "name": "sender", "in": "query", "description": "Filters operations by sender. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "address", "in": "query", "description": "Filters operations by global address of the created constant (starts with `expr..`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ExpressionParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters operations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters operations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filters operations by status (`applied`, `failed`, `backtracked`, `skipped`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts operations by specified field. Supported fields: `id` (default), `level`, `gasUsed`, `storageUsed`, `bakerFee`, `storageFee`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 9 }, { "name": "micheline", "in": "query", "description": "Format of the constant value: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 10 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 11 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RegisterConstantOperation" } } } } } } } }, "/v1/operations/register_constants/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get register constant by hash", "description": "Returns register global constant operation with specified hash.", "operationId": "Operations_GetRegisterConstantByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "micheline", "in": "query", "description": "Format of the constant value: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 2 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 3 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RegisterConstantOperation" } } } } } } } }, "/v1/operations/register_constants/{hash}/status": { "get": { "tags": [ "Operations" ], "summary": "Get register constant status", "description": "Returns operation status: `true` if applied, `false` if failed, `null` (or HTTP 204) if doesn't exist.", "operationId": "Operations_GetRegisterConstantStatus", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean", "nullable": true } } } } } } }, "/v1/operations/register_constants/count": { "get": { "tags": [ "Operations" ], "summary": "Get register constants count", "description": "Returns the total number of register global constant operations.", "operationId": "Operations_GetRegisterConstantsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters operations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters operations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/set_deposits_limits": { "get": { "tags": [ "Operations" ], "summary": "Get set deposits limits", "description": "Returns a list of set deposits limit operations.", "operationId": "Operations_GetSetDepositsLimits", "parameters": [ { "name": "sender", "in": "query", "description": "Filters by sender. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filters by status (`applied`, `failed`, `backtracked`, `skipped`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts by specified field. Supported fields: `id` (default), `level`, `gasUsed`, `bakerFee`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 8 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 9 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SetDepositsLimitOperation" } } } } } } } }, "/v1/operations/set_deposits_limits/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get set deposits limit by hash", "description": "Returns set deposits limit operation with specified hash.", "operationId": "Operations_GetSetDepositsLimitByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SetDepositsLimitOperation" } } } } } } } }, "/v1/operations/set_deposits_limits/{hash}/status": { "get": { "tags": [ "Operations" ], "summary": "Get set deposits limit status", "description": "Returns operation status: `true` if applied, `false` if failed, `null` (or HTTP 204) if doesn't exist.", "operationId": "Operations_GetSetDepositsLimitStatus", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean", "nullable": true } } } } } } }, "/v1/operations/set_deposits_limits/count": { "get": { "tags": [ "Operations" ], "summary": "Get set deposits limits count", "description": "Returns the total number of set deposits limit operations.", "operationId": "Operations_GetSetDepositsLimitsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/transfer_ticket": { "get": { "tags": [ "Operations" ], "summary": "Get transfer ticket", "description": "Returns a list of transfer ticket operations.", "operationId": "Operations_GetTransferTicketOps", "parameters": [ { "name": "anyof", "in": "query", "description": "Filters by any of the specified fields. Example: `anyof.sender.target=tz1...` will return operations where `sender` OR `target` is equal to the specified value. This parameter is useful when you need to retrieve all operations associated with a specified account.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AnyOfParameter" } ] }, "x-position": 1, "x-tzkt-extension": "anyof-parameter", "x-tzkt-anyof-parameter": "sender,target,ticketer" }, { "name": "sender", "in": "query", "description": "Filters by sender. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "target", "in": "query", "description": "Filters by target. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "id", "in": "query", "description": "Filters by id.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "ticketer", "in": "query", "description": "Filters by ticketer. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filters by status (`applied`, `failed`, `backtracked`, `skipped`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts by specified field. Supported fields: `id` (default), `level`, `gasUsed`, `bakerFee`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 10, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 11, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 12 }, { "name": "micheline", "in": "query", "description": "Format of the content value: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 13 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 14 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferTicketOperation" } } } } } } } }, "/v1/operations/transfer_ticket/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get transfer ticket by hash", "description": "Returns transfer ticket operation with specified hash.", "operationId": "Operations_GetTransferTicketOpsByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "micheline", "in": "query", "description": "Format of the content value: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 2 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 3 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferTicketOperation" } } } } } } } }, "/v1/operations/transfer_ticket/{hash}/status": { "get": { "tags": [ "Operations" ], "summary": "Get transfer ticket status", "description": "Returns operation status: `true` if applied, `false` if failed, `null` (or HTTP 204) if doesn't exist.", "operationId": "Operations_GetTransferTicketStatus", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean", "nullable": true } } } } } } }, "/v1/operations/transfer_ticket/count": { "get": { "tags": [ "Operations" ], "summary": "Get transfer ticket count", "description": "Returns the total number of transfer ticket operations.", "operationId": "Operations_GetTransferTicketOpsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/tx_rollup_commit": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup commit", "description": "Returns a list of tx rollup commit operations.", "operationId": "Operations_GetTxRollupCommitOps", "parameters": [ { "name": "sender", "in": "query", "description": "Filters by sender. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "rollup", "in": "query", "description": "Filters by rollup. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filters by status (`applied`, `failed`, `backtracked`, `skipped`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts by specified field. Supported fields: `id` (default), `level`, `gasUsed`, `bakerFee`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 9 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 10 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TxRollupCommitOperation" } } } } } } } }, "/v1/operations/tx_rollup_commit/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup commit by hash", "description": "Returns tx rollup commit operation with specified hash.", "operationId": "Operations_GetTxRollupCommitOpsByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TxRollupCommitOperation" } } } } } } } }, "/v1/operations/tx_rollup_commit/{hash}/status": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup commit status", "description": "Returns operation status: `true` if applied, `false` if failed, `null` (or HTTP 204) if doesn't exist.", "operationId": "Operations_GetTxRollupCommitStatus", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean", "nullable": true } } } } } } }, "/v1/operations/tx_rollup_commit/count": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup commit count", "description": "Returns the total number of tx rollup commit operations.", "operationId": "Operations_GetTxRollupCommitOpsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/tx_rollup_dispatch_tickets": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup dispatch tickets", "description": "Returns a list of tx rollup dispatch tickets operations.", "operationId": "Operations_GetTxRollupDispatchTicketsOps", "parameters": [ { "name": "sender", "in": "query", "description": "Filters by sender. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "rollup", "in": "query", "description": "Filters by rollup. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filters by status (`applied`, `failed`, `backtracked`, `skipped`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts by specified field. Supported fields: `id` (default), `level`, `gasUsed`, `bakerFee`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 9 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 10 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TxRollupDispatchTicketsOperation" } } } } } } } }, "/v1/operations/tx_rollup_dispatch_tickets/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup dispatch tickets by hash", "description": "Returns tx rollup dispatch tickets operation with specified hash.", "operationId": "Operations_GetTxRollupDispatchTicketsOpsByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TxRollupDispatchTicketsOperation" } } } } } } } }, "/v1/operations/tx_rollup_dispatch_tickets/{hash}/status": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup dispatch tickets status", "description": "Returns operation status: `true` if applied, `false` if failed, `null` (or HTTP 204) if doesn't exist.", "operationId": "Operations_GetTxRollupDispatchTicketsStatus", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean", "nullable": true } } } } } } }, "/v1/operations/tx_rollup_dispatch_tickets/count": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup dispatch tickets count", "description": "Returns the total number of tx rollup dispatch tickets operations.", "operationId": "Operations_GetTxRollupDispatchTicketsOpsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/tx_rollup_finalize_commitment": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup finalize commitment", "description": "Returns a list of tx rollup finalize commitment operations.", "operationId": "Operations_GetTxRollupFinalizeCommitmentOps", "parameters": [ { "name": "sender", "in": "query", "description": "Filters by sender. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "rollup", "in": "query", "description": "Filters by rollup. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filters by status (`applied`, `failed`, `backtracked`, `skipped`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts by specified field. Supported fields: `id` (default), `level`, `gasUsed`, `bakerFee`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 9 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 10 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TxRollupFinalizeCommitmentOperation" } } } } } } } }, "/v1/operations/tx_rollup_finalize_commitment/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup finalize commitment by hash", "description": "Returns tx rollup finalize commitment operation with specified hash.", "operationId": "Operations_GetTxRollupFinalizeCommitmentOpsByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TxRollupFinalizeCommitmentOperation" } } } } } } } }, "/v1/operations/tx_rollup_finalize_commitment/{hash}/status": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup finalize commitment status", "description": "Returns operation status: `true` if applied, `false` if failed, `null` (or HTTP 204) if doesn't exist.", "operationId": "Operations_GetTxRollupFinalizeCommitmentStatus", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean", "nullable": true } } } } } } }, "/v1/operations/tx_rollup_finalize_commitment/count": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup finalize commitment count", "description": "Returns the total number of tx rollup finalize commitment operations.", "operationId": "Operations_GetTxRollupFinalizeCommitmentOpsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/tx_rollup_origination": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup origination", "description": "Returns a list of tx rollup origination operations.", "operationId": "Operations_GetTxRollupOriginationOps", "parameters": [ { "name": "sender", "in": "query", "description": "Filters by sender. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "rollup", "in": "query", "description": "Filters by rollup. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filters by status (`applied`, `failed`, `backtracked`, `skipped`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts by specified field. Supported fields: `id` (default), `level`, `gasUsed`, `bakerFee`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 9 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 10 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TxRollupOriginationOperation" } } } } } } } }, "/v1/operations/tx_rollup_origination/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup origination by hash", "description": "Returns tx rollup origination operation with specified hash.", "operationId": "Operations_GetTxRollupOriginationOpsByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TxRollupOriginationOperation" } } } } } } } }, "/v1/operations/tx_rollup_origination/{hash}/status": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup origination status", "description": "Returns operation status: `true` if applied, `false` if failed, `null` (or HTTP 204) if doesn't exist.", "operationId": "Operations_GetTxRollupOriginationStatus", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean", "nullable": true } } } } } } }, "/v1/operations/tx_rollup_origination/count": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup origination count", "description": "Returns the total number of tx rollup origination operations.", "operationId": "Operations_GetTxRollupOriginationOpsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/tx_rollup_rejection": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup rejection", "description": "Returns a list of tx rollup rejection operations.", "operationId": "Operations_GetTxRollupRejectionOps", "parameters": [ { "name": "anyof", "in": "query", "description": "Filters by any of the specified fields. Example: `anyof.sender.committer=tz1...` will return operations where `sender` OR `committer` is equal to the specified value. This parameter is useful when you need to retrieve all operations associated with a specified account.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AnyOfParameter" } ] }, "x-position": 1, "x-tzkt-extension": "anyof-parameter", "x-tzkt-anyof-parameter": "sender,committer" }, { "name": "sender", "in": "query", "description": "Filters by sender. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "committer", "in": "query", "description": "Filters by committer. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "rollup", "in": "query", "description": "Filters by rollup. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filters by status (`applied`, `failed`, `backtracked`, `skipped`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts by specified field. Supported fields: `id` (default), `level`, `gasUsed`, `bakerFee`.", "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", "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", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 11 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 12 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TxRollupRejectionOperation" } } } } } } } }, "/v1/operations/tx_rollup_rejection/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup rejection by hash", "description": "Returns tx rollup rejection operation with specified hash.", "operationId": "Operations_GetTxRollupRejectionOpsByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TxRollupRejectionOperation" } } } } } } } }, "/v1/operations/tx_rollup_rejection/{hash}/status": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup rejection status", "description": "Returns operation status: `true` if applied, `false` if failed, `null` (or HTTP 204) if doesn't exist.", "operationId": "Operations_GetTxRollupRejectionStatus", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean", "nullable": true } } } } } } }, "/v1/operations/tx_rollup_rejection/count": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup rejection count", "description": "Returns the total number of tx rollup rejection operations.", "operationId": "Operations_GetTxRollupRejectionOpsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/tx_rollup_remove_commitment": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup remove commitment", "description": "Returns a list of tx rollup remove commitment operations.", "operationId": "Operations_GetTxRollupRemoveCommitmentOps", "parameters": [ { "name": "sender", "in": "query", "description": "Filters by sender. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "rollup", "in": "query", "description": "Filters by rollup. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filters by status (`applied`, `failed`, `backtracked`, `skipped`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts by specified field. Supported fields: `id` (default), `level`, `gasUsed`, `bakerFee`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 9 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 10 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TxRollupRemoveCommitmentOperation" } } } } } } } }, "/v1/operations/tx_rollup_remove_commitment/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup remove commitment by hash", "description": "Returns tx rollup remove commitment operation with specified hash.", "operationId": "Operations_GetTxRollupRemoveCommitmentOpsByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TxRollupRemoveCommitmentOperation" } } } } } } } }, "/v1/operations/tx_rollup_remove_commitment/{hash}/status": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup remove commitment status", "description": "Returns operation status: `true` if applied, `false` if failed, `null` (or HTTP 204) if doesn't exist.", "operationId": "Operations_GetTxRollupRemoveCommitmentStatus", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean", "nullable": true } } } } } } }, "/v1/operations/tx_rollup_remove_commitment/count": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup remove commitment count", "description": "Returns the total number of tx rollup remove commitment operations.", "operationId": "Operations_GetTxRollupRemoveCommitmentOpsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/tx_rollup_return_bond": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup return bond", "description": "Returns a list of tx rollup return bond operations.", "operationId": "Operations_GetTxRollupReturnBondOps", "parameters": [ { "name": "sender", "in": "query", "description": "Filters by sender. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "rollup", "in": "query", "description": "Filters by rollup. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filters by status (`applied`, `failed`, `backtracked`, `skipped`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts by specified field. Supported fields: `id` (default), `level`, `gasUsed`, `bakerFee`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 9 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 10 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TxRollupReturnBondOperation" } } } } } } } }, "/v1/operations/tx_rollup_return_bond/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup return bond by hash", "description": "Returns tx rollup return bond operation with specified hash.", "operationId": "Operations_GetTxRollupReturnBondOpsByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TxRollupReturnBondOperation" } } } } } } } }, "/v1/operations/tx_rollup_return_bond/{hash}/status": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup return bond status", "description": "Returns operation status: `true` if applied, `false` if failed, `null` (or HTTP 204) if doesn't exist.", "operationId": "Operations_GetTxRollupReturnBondStatus", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean", "nullable": true } } } } } } }, "/v1/operations/tx_rollup_return_bond/count": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup return bond count", "description": "Returns the total number of tx rollup return bond operations.", "operationId": "Operations_GetTxRollupReturnBondOpsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/tx_rollup_submit_batch": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup submit batch", "description": "Returns a list of tx rollup submit batch operations.", "operationId": "Operations_GetTxRollupSubmitBatchOps", "parameters": [ { "name": "sender", "in": "query", "description": "Filters by sender. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "rollup", "in": "query", "description": "Filters by rollup. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filters by status (`applied`, `failed`, `backtracked`, `skipped`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts by specified field. Supported fields: `id` (default), `level`, `gasUsed`, `bakerFee`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 9 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 10 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TxRollupSubmitBatchOperation" } } } } } } } }, "/v1/operations/tx_rollup_submit_batch/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup submit batch by hash", "description": "Returns tx rollup submit batch operation with specified hash.", "operationId": "Operations_GetTxRollupSubmitBatchOpsByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TxRollupSubmitBatchOperation" } } } } } } } }, "/v1/operations/tx_rollup_submit_batch/{hash}/status": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup submit batch status", "description": "Returns operation status: `true` if applied, `false` if failed, `null` (or HTTP 204) if doesn't exist.", "operationId": "Operations_GetTxRollupSubmitBatchStatus", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "boolean", "nullable": true } } } } } } }, "/v1/operations/tx_rollup_submit_batch/count": { "get": { "tags": [ "Operations" ], "summary": "Get tx rollup submit batch count", "description": "Returns the total number of tx rollup submit batch operations.", "operationId": "Operations_GetTxRollupSubmitBatchOpsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/increase_paid_storage": { "get": { "tags": [ "Operations" ], "summary": "Get increase paid storage", "description": "Returns a list of increase paid storage operations.", "operationId": "Operations_GetIncreasePaidStorageOps", "parameters": [ { "name": "sender", "in": "query", "description": "Filters by sender. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "contract", "in": "query", "description": "Filters by contract. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filters by status (`applied`, `failed`, `backtracked`, `skipped`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts operations by specified field. Supported fields: `id` (default), `level`, `gasUsed`, `storageUsed`, `bakerFee`, `storageFee`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 9 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 10 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncreasePaidStorageOperation" } } } } } } } }, "/v1/operations/increase_paid_storage/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get increase paid storage by hash", "description": "Returns increase paid storage operation with specified hash.", "operationId": "Operations_GetIncreasePaidStorageByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncreasePaidStorageOperation" } } } } } } } }, "/v1/operations/increase_paid_storage/count": { "get": { "tags": [ "Operations" ], "summary": "Get increase paid storage count", "description": "Returns the total number of increase paid storage operations.", "operationId": "Operations_GetIncreasePaidStorageCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters operations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters operations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/update_secondary_key": { "get": { "tags": [ "Operations" ], "summary": "Get update secondary key", "description": "Returns a list of update secondary key operations.", "operationId": "Operations_GetUpdateSecondaryKeyOps", "parameters": [ { "name": "sender", "in": "query", "description": "Filters by sender. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "keyType", "in": "query", "description": "Filters by key type (`consensus` or `companion`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SecondaryKeyTypeParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "consensus,companion" }, { "name": "activationCycle", "in": "query", "description": "Filters by activation cycle.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "publicKeyHash", "in": "query", "description": "Filters by pkh (tz address).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AddressParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filters by status (`applied`, `failed`, `backtracked`, `skipped`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts operations by specified field. Supported fields: `id` (default), `level`, `gasUsed`, `storageUsed`, `bakerFee`, `storageFee`.", "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", "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", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 11 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 12 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateSecondaryKeyOperation" } } } } } } } }, "/v1/operations/update_secondary_key/{hash}": { "get": { "tags": [ "Operations" ], "summary": "Get update secondary key by hash", "description": "Returns update secondary key operation with specified hash.", "operationId": "Operations_GetUpdateSecondaryKeyByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Operation hash", "schema": { "type": "string" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateSecondaryKeyOperation" } } } } } } } }, "/v1/operations/update_secondary_key/count": { "get": { "tags": [ "Operations" ], "summary": "Get update secondary key count", "description": "Returns the total number of update secondary key operations.", "operationId": "Operations_GetUpdateSecondaryKeyOpsCount", "parameters": [ { "name": "keyType", "in": "query", "description": "Filters operations key type (`consensus` or `companion`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SecondaryKeyTypeParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "consensus,companion" }, { "name": "level", "in": "query", "description": "Filters operations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters operations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/sr_add_messages": { "get": { "tags": [ "Operations" ], "summary": "Get smart rollup add messages", "description": "Returns a list of smart rollup add messages operations.", "operationId": "Operations_GetSmartRollupAddMessagesOps", "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": "hash", "in": "query", "description": "Filter by operation hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpHashParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "counter", "in": "query", "description": "Filter by operation counter. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp (ISO 8601) of the operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by operation status (`applied`, `failed`, `backtracked`, `skipped`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "sender", "in": "query", "description": "Filter by operation sender address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 8 }, { "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" }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 13 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmartRollupAddMessagesOperation" } } } } } } } }, "/v1/operations/sr_add_messages/count": { "get": { "tags": [ "Operations" ], "summary": "Get smart rollup add messages count", "description": "Returns a total number of smart rollup add messages operations.", "operationId": "Operations_GetSmartRollupAddMessagesOpsCount", "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": "hash", "in": "query", "description": "Filter by operation hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpHashParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "counter", "in": "query", "description": "Filter by operation counter. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp (ISO 8601) of the operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by operation status (`applied`, `failed`, `backtracked`, `skipped`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "sender", "in": "query", "description": "Filter by operation sender address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 8 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/sr_cement": { "get": { "tags": [ "Operations" ], "summary": "Get smart rollup cement", "description": "Returns a list of smart rollup cement operations.", "operationId": "Operations_GetSmartRollupCementOps", "parameters": [ { "name": "rollup", "in": "query", "description": "Filter by rollup address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SmartRollupParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "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": 2, "x-tzkt-extension": "query-parameter" }, { "name": "hash", "in": "query", "description": "Filter by operation hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpHashParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "counter", "in": "query", "description": "Filter by operation counter. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp (ISO 8601) of the operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by operation status (`applied`, `failed`, `backtracked`, `skipped`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "sender", "in": "query", "description": "Filter by operation sender address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 9 }, { "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": 10, "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": 11, "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": 12 }, { "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": 13, "x-tzkt-extension": "query-parameter" }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 14 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmartRollupCementOperation" } } } } } } } }, "/v1/operations/sr_cement/count": { "get": { "tags": [ "Operations" ], "summary": "Get smart rollup cement count", "description": "Returns a total number of smart rollup cement operations.", "operationId": "Operations_GetSmartRollupCementOpsCount", "parameters": [ { "name": "rollup", "in": "query", "description": "Filter by rollup address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SmartRollupParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "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": 2, "x-tzkt-extension": "query-parameter" }, { "name": "hash", "in": "query", "description": "Filter by operation hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpHashParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "counter", "in": "query", "description": "Filter by operation counter. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp (ISO 8601) of the operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by operation status (`applied`, `failed`, `backtracked`, `skipped`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "sender", "in": "query", "description": "Filter by operation sender address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 9 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/sr_execute": { "get": { "tags": [ "Operations" ], "summary": "Get smart rollup execute", "description": "Returns a list of smart rollup execute operations.", "operationId": "Operations_GetSmartRollupExecuteOps", "parameters": [ { "name": "rollup", "in": "query", "description": "Filter by rollup address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SmartRollupParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "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": 2, "x-tzkt-extension": "query-parameter" }, { "name": "hash", "in": "query", "description": "Filter by operation hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpHashParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "counter", "in": "query", "description": "Filter by operation counter. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp (ISO 8601) of the operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by operation status (`applied`, `failed`, `backtracked`, `skipped`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "sender", "in": "query", "description": "Filter by operation sender address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 9 }, { "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": 10, "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": 11, "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": 12 }, { "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": 13, "x-tzkt-extension": "query-parameter" }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 14 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmartRollupExecuteOperation" } } } } } } } }, "/v1/operations/sr_execute/count": { "get": { "tags": [ "Operations" ], "summary": "Get smart rollup execute count", "description": "Returns a total number of smart rollup execute operations.", "operationId": "Operations_GetSmartRollupExecuteOpsCount", "parameters": [ { "name": "rollup", "in": "query", "description": "Filter by rollup address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SmartRollupParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "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": 2, "x-tzkt-extension": "query-parameter" }, { "name": "hash", "in": "query", "description": "Filter by operation hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpHashParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "counter", "in": "query", "description": "Filter by operation counter. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp (ISO 8601) of the operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by operation status (`applied`, `failed`, `backtracked`, `skipped`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "sender", "in": "query", "description": "Filter by operation sender address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 9 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/sr_originate": { "get": { "tags": [ "Operations" ], "summary": "Get smart rollup originate", "description": "Returns a list of smart rollup originate operations.", "operationId": "Operations_GetSmartRollupOriginateOps", "parameters": [ { "name": "rollup", "in": "query", "description": "Filter by rollup address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SmartRollupParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "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": 2, "x-tzkt-extension": "query-parameter" }, { "name": "hash", "in": "query", "description": "Filter by operation hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpHashParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "counter", "in": "query", "description": "Filter by operation counter. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp (ISO 8601) of the operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by operation status (`applied`, `failed`, `backtracked`, `skipped`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "sender", "in": "query", "description": "Filter by operation sender address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 9 }, { "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": 10, "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": 11, "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": 12 }, { "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": 13, "x-tzkt-extension": "query-parameter" }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 14 }, { "name": "micheline", "in": "query", "description": "Format of the parameter type value: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 15 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmartRollupOriginateOperation" } } } } } } } }, "/v1/operations/sr_originate/count": { "get": { "tags": [ "Operations" ], "summary": "Get smart rollup originate count", "description": "Returns a total number of smart rollup originate operations.", "operationId": "Operations_GetSmartRollupOriginateOpsCount", "parameters": [ { "name": "rollup", "in": "query", "description": "Filter by rollup address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SmartRollupParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "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": 2, "x-tzkt-extension": "query-parameter" }, { "name": "hash", "in": "query", "description": "Filter by operation hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpHashParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "counter", "in": "query", "description": "Filter by operation counter. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp (ISO 8601) of the operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by operation status (`applied`, `failed`, `backtracked`, `skipped`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "sender", "in": "query", "description": "Filter by operation sender address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 9 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/sr_publish": { "get": { "tags": [ "Operations" ], "summary": "Get smart rollup publish", "description": "Returns a list of smart rollup publish operations.", "operationId": "Operations_GetSmartRollupPublishOps", "parameters": [ { "name": "commitment.id", "in": "query", "description": "Filter by internal TzKT id. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "commitment.hash", "in": "query", "description": "Filter by commitment hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Src1HashParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "rollup", "in": "query", "description": "Filter by rollup address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SmartRollupParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "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": 4, "x-tzkt-extension": "query-parameter" }, { "name": "hash", "in": "query", "description": "Filter by operation hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpHashParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "counter", "in": "query", "description": "Filter by operation counter. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp (ISO 8601) of the operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by operation status (`applied`, `failed`, `backtracked`, `skipped`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "sender", "in": "query", "description": "Filter by operation sender 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": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 11 }, { "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": 12, "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": 13, "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": 14 }, { "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": 15, "x-tzkt-extension": "query-parameter" }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 16 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmartRollupPublishOperation" } } } } } } } }, "/v1/operations/sr_publish/count": { "get": { "tags": [ "Operations" ], "summary": "Get smart rollup publish count", "description": "Returns a total number of smart rollup publish operations.", "operationId": "Operations_GetSmartRollupPublishOpsCount", "parameters": [ { "name": "commitment.id", "in": "query", "description": "Filter by internal TzKT id. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "commitment.hash", "in": "query", "description": "Filter by commitment hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Src1HashParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "rollup", "in": "query", "description": "Filter by rollup address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SmartRollupParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "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": 4, "x-tzkt-extension": "query-parameter" }, { "name": "hash", "in": "query", "description": "Filter by operation hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpHashParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "counter", "in": "query", "description": "Filter by operation counter. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp (ISO 8601) of the operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by operation status (`applied`, `failed`, `backtracked`, `skipped`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "sender", "in": "query", "description": "Filter by operation sender 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": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 11 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/sr_recover_bond": { "get": { "tags": [ "Operations" ], "summary": "Get smart rollup recover bond", "description": "Returns a list of smart rollup recover bond operations.", "operationId": "Operations_GetSmartRollupRecoverBondOps", "parameters": [ { "name": "anyof", "in": "query", "description": "Filter by any of the specified fields (`sender` or `staker`).\nExample: `anyof.sender.staker=tz1...` will return operations where `sender` OR `staker` is equal to the specified value.\nThis parameter is useful when you need to get all operations somehow related to the account in a single request. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AnyOfParameter" } ] }, "x-position": 1, "x-tzkt-extension": "anyof-parameter" }, { "name": "staker", "in": "query", "description": "Filter by staker 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": "rollup", "in": "query", "description": "Filter by rollup address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SmartRollupParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "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": 4, "x-tzkt-extension": "query-parameter" }, { "name": "hash", "in": "query", "description": "Filter by operation hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpHashParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "counter", "in": "query", "description": "Filter by operation counter. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp (ISO 8601) of the operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by operation status (`applied`, `failed`, `backtracked`, `skipped`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "sender", "in": "query", "description": "Filter by operation sender 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": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 11 }, { "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": 12, "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": 13, "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": 14 }, { "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": 15, "x-tzkt-extension": "query-parameter" }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 16 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmartRollupRecoverBondOperation" } } } } } } } }, "/v1/operations/sr_recover_bond/count": { "get": { "tags": [ "Operations" ], "summary": "Get smart rollup recover bond count", "description": "Returns a total number of smart rollup recover bond operations.", "operationId": "Operations_GetSmartRollupRecoverBondOpsCount", "parameters": [ { "name": "anyof", "in": "query", "description": "Filter by any of the specified fields (`sender` or `staker`).\nExample: `anyof.sender.staker=tz1...` will return operations where `sender` OR `staker` is equal to the specified value.\nThis parameter is useful when you need to get all operations somehow related to the account in a single request. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AnyOfParameter" } ] }, "x-position": 1, "x-tzkt-extension": "anyof-parameter" }, { "name": "staker", "in": "query", "description": "Filter by staker 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": "rollup", "in": "query", "description": "Filter by rollup address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SmartRollupParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "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": 4, "x-tzkt-extension": "query-parameter" }, { "name": "hash", "in": "query", "description": "Filter by operation hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpHashParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "counter", "in": "query", "description": "Filter by operation counter. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp (ISO 8601) of the operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by operation status (`applied`, `failed`, `backtracked`, `skipped`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "sender", "in": "query", "description": "Filter by operation sender 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": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 11 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/sr_refute": { "get": { "tags": [ "Operations" ], "summary": "Get smart rollup refute", "description": "Returns a list of smart rollup refute operations.", "operationId": "Operations_GetSmartRollupRefuteOps", "parameters": [ { "name": "anyof", "in": "query", "description": "Filter by any of the specified fields (`sender`, `initiator`, or `opponent`).\nExample: `anyof.initiator.opponent=tz1...` will return operations where `initiator` OR `opponent` is equal to the specified value.\nThis parameter is useful when you need to get all operations somehow related to the account in a single request. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AnyOfParameter" } ] }, "x-position": 1, "x-tzkt-extension": "anyof-parameter" }, { "name": "game.id", "in": "query", "description": "Filter by internal TzKT id. \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": "game.initiator", "in": "query", "description": "Filter by initiator (who found a wrong commitment and started the refutation game). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "game.initiatorCommitment.id", "in": "query", "description": "Filter by internal TzKT id. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "game.initiatorCommitment.hash", "in": "query", "description": "Filter by commitment hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Src1HashParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "game.opponent", "in": "query", "description": "Filter by opponent (who was accused in publishing a wrong commitment). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "game.opponentCommitment.id", "in": "query", "description": "Filter by internal TzKT id. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "game.opponentCommitment.hash", "in": "query", "description": "Filter by commitment hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Src1HashParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "move", "in": "query", "description": "Filter by refutation game move (`start`, `dissection`, `proof`, or `timeout`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RefutationMoveParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "start,dissection,proof,timeout" }, { "name": "gameStatus", "in": "query", "description": "Filter by refutation game status (`none`, `ongoing`, `loser`, or `draw`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RefutationGameStatusParameter" } ] }, "x-position": 10, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "none,ongoing,loser,draw" }, { "name": "rollup", "in": "query", "description": "Filter by rollup address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SmartRollupParameter" } ] }, "x-position": 11, "x-tzkt-extension": "query-parameter" }, { "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": 12, "x-tzkt-extension": "query-parameter" }, { "name": "hash", "in": "query", "description": "Filter by operation hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpHashParameter" } ] }, "x-position": 13, "x-tzkt-extension": "query-parameter" }, { "name": "counter", "in": "query", "description": "Filter by operation counter. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 14, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 15, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp (ISO 8601) of the operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 16, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by operation status (`applied`, `failed`, `backtracked`, `skipped`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 17, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "sender", "in": "query", "description": "Filter by operation sender address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 18, "x-tzkt-extension": "query-parameter" }, { "name": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 19 }, { "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": 20, "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": 21, "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": 22 }, { "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": 23, "x-tzkt-extension": "query-parameter" }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 24 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmartRollupRefuteOperation" } } } } } } } }, "/v1/operations/sr_refute/count": { "get": { "tags": [ "Operations" ], "summary": "Get smart rollup refute count", "description": "Returns a total number of smart rollup refute operations.", "operationId": "Operations_GetSmartRollupRefuteOpsCount", "parameters": [ { "name": "anyof", "in": "query", "description": "Filter by any of the specified fields (`sender`, `initiator`, or `opponent`).\nExample: `anyof.initiator.opponent=tz1...` will return operations where `initiator` OR `opponent` is equal to the specified value.\nThis parameter is useful when you need to get all operations somehow related to the account in a single request. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AnyOfParameter" } ] }, "x-position": 1, "x-tzkt-extension": "anyof-parameter" }, { "name": "game.id", "in": "query", "description": "Filter by internal TzKT id. \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": "game.initiator", "in": "query", "description": "Filter by initiator (who found a wrong commitment and started the refutation game). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "game.initiatorCommitment.id", "in": "query", "description": "Filter by internal TzKT id. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "game.initiatorCommitment.hash", "in": "query", "description": "Filter by commitment hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Src1HashParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "game.opponent", "in": "query", "description": "Filter by opponent (who was accused in publishing a wrong commitment). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "game.opponentCommitment.id", "in": "query", "description": "Filter by internal TzKT id. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "game.opponentCommitment.hash", "in": "query", "description": "Filter by commitment hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Src1HashParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "move", "in": "query", "description": "Filter by refutation game move (`start`, `dissection`, `proof`, or `timeout`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RefutationMoveParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "start,dissection,proof,timeout" }, { "name": "gameStatus", "in": "query", "description": "Filter by refutation game status (`none`, `ongoing`, `loser`, or `draw`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RefutationGameStatusParameter" } ] }, "x-position": 10, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "none,ongoing,loser,draw" }, { "name": "rollup", "in": "query", "description": "Filter by rollup address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SmartRollupParameter" } ] }, "x-position": 11, "x-tzkt-extension": "query-parameter" }, { "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": 12, "x-tzkt-extension": "query-parameter" }, { "name": "hash", "in": "query", "description": "Filter by operation hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpHashParameter" } ] }, "x-position": 13, "x-tzkt-extension": "query-parameter" }, { "name": "counter", "in": "query", "description": "Filter by operation counter. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 14, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 15, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp (ISO 8601) of the operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 16, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by operation status (`applied`, `failed`, `backtracked`, `skipped`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 17, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "sender", "in": "query", "description": "Filter by operation sender address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 18, "x-tzkt-extension": "query-parameter" }, { "name": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 19 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/staking": { "get": { "tags": [ "Operations" ], "summary": "Get staking ops", "description": "Returns a list of staking operations.", "operationId": "Operations_GetStakingOps", "parameters": [ { "name": "anyof", "in": "query", "description": "Filter by any of the specified fields (`sender`, or `baker`).\nExample: `anyof.sender.baker=tz1...` will return operations where `sender` OR `baker` is equal to the specified value.\nThis parameter is useful when you need to get all operations somehow related to the account in a single request. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AnyOfParameter" } ] }, "x-position": 1, "x-tzkt-extension": "anyof-parameter" }, { "name": "staker", "in": "query", "description": "Filter by staker 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": "baker", "in": "query", "description": "Filter by baker address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "action", "in": "query", "description": "Filter by staking action (`stake`, `unstake`, `finalize`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/StakingActionParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "stake,unstake,finalize" }, { "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": 5, "x-tzkt-extension": "query-parameter" }, { "name": "hash", "in": "query", "description": "Filter by operation hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpHashParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "counter", "in": "query", "description": "Filter by operation counter. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp (ISO 8601) of the operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by operation status (`applied`, `failed`, `backtracked`, `skipped`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 10, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "sender", "in": "query", "description": "Filter by operation sender 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": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 12 }, { "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": 13, "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": 14, "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": 15 }, { "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": 16, "x-tzkt-extension": "query-parameter" }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 17 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StakingOperation" } } } } } } } }, "/v1/operations/staking/count": { "get": { "tags": [ "Operations" ], "summary": "Get staking ops count", "description": "Returns a total number of staking operations.", "operationId": "Operations_GetStakingOpsCount", "parameters": [ { "name": "anyof", "in": "query", "description": "Filter by any of the specified fields (`sender`, or `baker`).\nExample: `anyof.sender.baker=tz1...` will return operations where `sender` OR `baker` is equal to the specified value.\nThis parameter is useful when you need to get all operations somehow related to the account in a single request. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AnyOfParameter" } ] }, "x-position": 1, "x-tzkt-extension": "anyof-parameter" }, { "name": "staker", "in": "query", "description": "Filter by staker 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": "baker", "in": "query", "description": "Filter by baker address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "action", "in": "query", "description": "Filter by staking action (`stake`, `unstake`, `finalize`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/StakingActionParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "stake,unstake,finalize" }, { "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": 5, "x-tzkt-extension": "query-parameter" }, { "name": "hash", "in": "query", "description": "Filter by operation hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpHashParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "counter", "in": "query", "description": "Filter by operation counter. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp (ISO 8601) of the operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by operation status (`applied`, `failed`, `backtracked`, `skipped`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 10, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "sender", "in": "query", "description": "Filter by operation sender 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": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 12 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/migrations": { "get": { "tags": [ "Operations" ], "summary": "Get migrations", "description": "Returns a list of migration operations (synthetic type).", "operationId": "Operations_GetMigrations", "parameters": [ { "name": "account", "in": "query", "description": "Filters migration operations by account. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "kind", "in": "query", "description": "Filters migration operations by kind (`bootstrap`, `activate_delegate`, `airdrop`, `proposal_invoice`, `origination`, `subsidy`, `remove_bigmap_key`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MigrationKindParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "bootstrap,activate_delegate,airdrop,proposal_invoice,code_change,origination,subsidy,remove_bigmap_key" }, { "name": "balanceChange", "in": "query", "description": "Filters migration operations by amount.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "id", "in": "query", "description": "Filters migration operations by internal TzKT id.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters migration operations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters migration operations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts migrations by specified field. Supported fields: `id` (default), `level`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 10 }, { "name": "micheline", "in": "query", "description": "Format of the parameters, storage and diffs: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 11 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 12 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MigrationOperation" } } } } } } } }, "/v1/operations/migrations/{id}": { "get": { "tags": [ "Operations" ], "summary": "Get migration by id", "description": "Returns migration operation with specified id.", "operationId": "Operations_GetMigrationById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Operation id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "name": "micheline", "in": "query", "description": "Format of the parameters, storage and diffs: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 2 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 3 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MigrationOperation" } } } } } } }, "/v1/operations/migrations/count": { "get": { "tags": [ "Operations" ], "summary": "Get migrations count", "description": "Returns the total number of migration operations (synthetic type).", "operationId": "Operations_GetMigrationsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters migrations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters migrations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/revelation_penalties": { "get": { "tags": [ "Operations" ], "summary": "Get revelation penalties", "description": "Returns a list of revelation penalty operations (synthetic type).", "operationId": "Operations_GetRevelationPenalties", "parameters": [ { "name": "id", "in": "query", "description": "Filters operations by internal TzKT id.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "baker", "in": "query", "description": "Filters revelation penalty operations by baker. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters revelation penalty operations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters revelation penalty operations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts revelation penalty operations by specified field. Supported fields: `id` (default), `level`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 8 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 9 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RevelationPenaltyOperation" } } } } } } } }, "/v1/operations/revelation_penalties/{id}": { "get": { "tags": [ "Operations" ], "summary": "Get revelation penalty by id", "description": "Returns revelation penalty operation with specified id.", "operationId": "Operations_GetRevelationPenaltyById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Operation id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevelationPenaltyOperation" } } } } } } }, "/v1/operations/revelation_penalties/count": { "get": { "tags": [ "Operations" ], "summary": "Get revelation penalties count", "description": "Returns the total number of revelation penalty operations (synthetic type).", "operationId": "Operations_GetRevelationPenaltiesCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters revelation penalty operations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters revelation penalty operations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/baking": { "get": { "tags": [ "Operations" ], "summary": "Get baking", "description": "Returns a list of baking operations (synthetic type).", "operationId": "Operations_GetBaking", "parameters": [ { "name": "anyof", "in": "query", "description": "Filters by any of the specified fields. Example: `anyof.proposer.producer=tz1...`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AnyOfParameter" } ] }, "x-position": 1, "x-tzkt-extension": "anyof-parameter", "x-tzkt-anyof-parameter": "proposer,producer" }, { "name": "proposer", "in": "query", "description": "Filters by block proposer. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "producer", "in": "query", "description": "Filters by block producer. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "id", "in": "query", "description": "Filters operations by internal TzKT id.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters baking operations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters baking operations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts baking operations by specified field. Supported fields: `id` (default), `level`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 10 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 11 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BakingOperation" } } } } } } } }, "/v1/operations/baking/{id}": { "get": { "tags": [ "Operations" ], "summary": "Get baking by id", "description": "Returns baking operation with specified id.", "operationId": "Operations_GetBakingById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Operation id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BakingOperation" } } } } } } }, "/v1/operations/baking/count": { "get": { "tags": [ "Operations" ], "summary": "Get baking count", "description": "Returns the total number of baking operations (synthetic type).", "operationId": "Operations_GetBakingCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters baking operations by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters baking operations by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/attestation_rewards": { "get": { "tags": [ "Operations" ], "summary": "Get attestation rewards", "description": "Returns a list of attestation reward operations (synthetic type).", "operationId": "Operations_GetAttestationRewards", "parameters": [ { "name": "id", "in": "query", "description": "Filters operations by internal TzKT id.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "baker", "in": "query", "description": "Filters by baker. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts by specified field. Supported fields: `id` (default), `level`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 8 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 9 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttestationRewardOperation" } } } } } } } }, "/v1/operations/attestation_rewards/{id}": { "get": { "tags": [ "Operations" ], "summary": "Get attestation reward by id", "description": "Returns attestation reward operation with specified id.", "operationId": "Operations_GetAttestationRewardById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Operation id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttestationRewardOperation" } } } } } } }, "/v1/operations/attestation_rewards/count": { "get": { "tags": [ "Operations" ], "summary": "Get attestation rewards count", "description": "Returns the total number of attestation reward operations (synthetic type).", "operationId": "Operations_GetAttestationRewardsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/dal_attestation_reward": { "get": { "tags": [ "Operations" ], "summary": "Get dal attestation rewards", "description": "Returns a list of dal attestation reward operations (synthetic type).", "operationId": "Operations_GetDalAttestationRewards", "parameters": [ { "name": "id", "in": "query", "description": "Filters operations by internal TzKT id.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "baker", "in": "query", "description": "Filters by baker. Allowed fields for `.eqx` mode: none.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts by specified field. Supported fields: `id` (default), `level`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 8 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 9 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DalAttestationRewardOperation" } } } } } } } }, "/v1/operations/dal_attestation_reward/{id}": { "get": { "tags": [ "Operations" ], "summary": "Get dal attestation reward by id", "description": "Returns dal attestation reward operation with specified id.", "operationId": "Operations_GetDalAttestationRewardById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Operation id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DalAttestationRewardOperation" } } } } } } }, "/v1/operations/dal_attestation_reward/count": { "get": { "tags": [ "Operations" ], "summary": "Get dal attestation rewards count", "description": "Returns the total number of dal attestation reward operations (synthetic type).", "operationId": "Operations_GetDalAttestationRewardsCount", "parameters": [ { "name": "level", "in": "query", "description": "Filters by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/autostaking": { "get": { "tags": [ "Operations" ], "summary": "Get autostaking ops", "description": "Returns a list of autostaking operations.", "operationId": "Operations_GetAutostakingOps", "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 operation happened. \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 operation happened. \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": "baker", "in": "query", "description": "Filter by baker. \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": "action", "in": "query", "description": "Filter by autostaking action. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/StakingActionParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "stake,unstake,finalize" }, { "name": "amount", "in": "query", "description": "Filter by amount. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "stakingUpdatesCount", "in": "query", "description": "Filter by number of staking updates. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 8 }, { "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" }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 13 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AutostakingOperation" } } } } } } } }, "/v1/operations/autostaking/count": { "get": { "tags": [ "Operations" ], "summary": "Get autostaking ops count", "description": "Returns a total number of autostaking operations.", "operationId": "Operations_GetAutostakingOpsCount", "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 operation happened. \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 operation happened. \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": "baker", "in": "query", "description": "Filter by baker. \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": "action", "in": "query", "description": "Filter by autostaking action. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/StakingActionParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "stake,unstake,finalize" }, { "name": "amount", "in": "query", "description": "Filter by amount. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "stakingUpdatesCount", "in": "query", "description": "Filter by number of staking updates. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 8 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/set_delegate_parameters": { "get": { "tags": [ "Operations" ], "summary": "Get set_delegate_parameters ops", "description": "Returns a list of set_delegate_parameters operations.", "operationId": "Operations_GetSetDelegateParametersOps", "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": "hash", "in": "query", "description": "Filter by operation hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpHashParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "counter", "in": "query", "description": "Filter by operation counter. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp (ISO 8601) of the operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by operation status (`applied`, `failed`, `backtracked`, `skipped`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "sender", "in": "query", "description": "Filter by operation sender address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 8 }, { "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" }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 13 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SetDelegateParametersOperation" } } } } } } } }, "/v1/operations/set_delegate_parameters/count": { "get": { "tags": [ "Operations" ], "summary": "Get set_delegate_parameters ops count", "description": "Returns a total number of set_delegate_parameters operations.", "operationId": "Operations_GetSetDelegateParametersOpsCount", "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": "hash", "in": "query", "description": "Filter by operation hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpHashParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "counter", "in": "query", "description": "Filter by operation counter. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp (ISO 8601) of the operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by operation status (`applied`, `failed`, `backtracked`, `skipped`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "sender", "in": "query", "description": "Filter by operation sender address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 8 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/operations/dal_publish_commitment": { "get": { "tags": [ "Operations" ], "summary": "Get dal_publish_commitment ops", "description": "Returns a list of dal_publish_commitment operations.", "operationId": "Operations_GetDalPublishCommitmentOps", "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": "hash", "in": "query", "description": "Filter by operation hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpHashParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "counter", "in": "query", "description": "Filter by operation counter. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp (ISO 8601) of the operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by operation status (`applied`, `failed`, `backtracked`, `skipped`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "sender", "in": "query", "description": "Filter by operation sender address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 8 }, { "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" }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 13 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DalPublishCommitmentOperation" } } } } } } } }, "/v1/operations/dal_publish_commitment/count": { "get": { "tags": [ "Operations" ], "summary": "Get dal_publish_commitment ops count", "description": "Returns a total number of dal_publish_commitment operations.", "operationId": "Operations_GetDalPublishCommitmentOpsCount", "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": "hash", "in": "query", "description": "Filter by operation hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OpHashParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "counter", "in": "query", "description": "Filter by operation counter. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by the domain level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filter by timestamp (ISO 8601) of the operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by operation status (`applied`, `failed`, `backtracked`, `skipped`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OperationStatusParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, { "name": "sender", "in": "query", "description": "Filter by operation sender address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 8 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/protocols/count": { "get": { "tags": [ "Protocols" ], "summary": "Get protocols count", "description": "Returns the total number of protocols.", "operationId": "Protocols_GetCount", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/protocols": { "get": { "tags": [ "Protocols" ], "summary": "Get protocols", "description": "Returns a list of protocols.", "operationId": "Protocols_Get", "parameters": [ { "name": "sort", "in": "query", "description": "Sorts protocols by specified field. Supported fields: `code` (default), `firstLevel`, `lastLevel`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 3 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Protocol" } } } } } } } }, "/v1/protocols/current": { "get": { "tags": [ "Protocols" ], "summary": "Get current protocol", "description": "Returns current protocol.", "operationId": "Protocols_GetCurrent", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Protocol" } } } } } } }, "/v1/protocols/{code}": { "get": { "tags": [ "Protocols" ], "summary": "Get protocol by code", "description": "Returns a protocol with the specified proto code.", "operationId": "Protocols_GetByCode", "parameters": [ { "name": "code", "in": "path", "required": true, "description": "Protocol code (e.g. 4 for Athens, 5 for Babylon, etc)", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Protocol" } } } } } } }, "/v1/protocols/{hash}": { "get": { "tags": [ "Protocols" ], "summary": "Get protocol by hash", "description": "Returns a protocol with the specified hash.", "operationId": "Protocols_GetByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Protocol hash", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Protocol" } } } } } } }, "/v1/protocols/cycles/{cycle}": { "get": { "tags": [ "Protocols" ], "summary": "Get protocol by cycle", "description": "Returns a protocol at the specified cycle.", "operationId": "Protocols_GetByCycle", "parameters": [ { "name": "cycle", "in": "path", "required": true, "description": "Cycle index", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Protocol" } } } } } } }, "/v1/quotes/count": { "get": { "tags": [ "Quotes" ], "summary": "Get quotes count", "description": "Returns the total number of quotes aligned with blocks.", "operationId": "Quotes_GetCount", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/quotes/last": { "get": { "tags": [ "Quotes" ], "summary": "Get last quote", "description": "Returns last known quote.", "operationId": "Quotes_GetLast", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Quote" } } } } } } }, "/v1/quotes": { "get": { "tags": [ "Quotes" ], "summary": "Get quotes", "description": "Returns a list of quotes aligned with blocks.", "operationId": "Quotes_Get", "parameters": [ { "name": "level", "in": "query", "description": "Filters quotes by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters quotes by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DateTimeParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts quotes by specified field. Supported fields: `level` (default).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 6 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } } } } } } } }, "/v1/rewards/bakers/{address}/count": { "get": { "tags": [ "Rewards" ], "summary": "Get baker cycle rewards count", "description": "Returns total number of cycles where the baker was active", "operationId": "Rewards_GetBakerRewardsCount", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Baker address", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/rewards/bakers/{address}": { "get": { "tags": [ "Rewards" ], "summary": "Get baker cycle rewards", "description": "Returns a list of baker rewards for every cycle, including future cycles.", "operationId": "Rewards_GetBakerRewards", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Baker address.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "cycle", "in": "query", "description": "Filter by cycle.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 2, "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": 3, "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": 4, "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": 5 }, { "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": 6, "x-tzkt-extension": "query-parameter" }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 7 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BakerRewards" } } } } } } } }, "/v1/rewards/delegators/{address}/count": { "get": { "tags": [ "Rewards" ], "summary": "Get delegator cycle rewards count", "description": "Returns total number of cycles where the delegator was delegated to an active baker", "operationId": "Rewards_GetDelegatorRewardsCount", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Delegator address", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/rewards/delegators/{address}": { "get": { "tags": [ "Rewards" ], "summary": "Get delegator cycle rewards", "description": "Returns a list of delegator rewards for every cycle, including future cycles.", "operationId": "Rewards_GetDelegatorRewards", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Delegator address.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "cycle", "in": "query", "description": "Filter by cycle.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 2, "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": 3, "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": 4, "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": 5 }, { "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": 6, "x-tzkt-extension": "query-parameter" }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 7 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DelegatorRewards" } } } } } } } }, "/v1/rewards/stakers/{address}/count": { "get": { "tags": [ "Rewards" ], "summary": "Get staker cycle rewards count", "description": "Returns total number of cycles where the staker was staking to an active baker", "operationId": "Rewards_GetStakerRewardsCount", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Staker address", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/rewards/stakers/{address}": { "get": { "tags": [ "Rewards" ], "summary": "Get staker cycle rewards", "description": "Returns a list of staker rewards.", "operationId": "Rewards_GetStakerRewards", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Staker address.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "cycle", "in": "query", "description": "Filter by cycle.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 2, "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": 3, "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": 4, "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": 5 }, { "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": 6, "x-tzkt-extension": "query-parameter" }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 7 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StakerRewards" } } } } } } } }, "/v1/rewards/split/{baker}/{cycle}": { "get": { "tags": [ "Rewards" ], "summary": "Get reward split", "description": "Returns baker rewards for the specified cycle with all delegators and stakers (both snapshotted and actual ones).\nThis endpoint helps to distribute delegation rewards between delegators in proportion to their delegated balances.", "operationId": "Rewards_GetRewardSplit", "parameters": [ { "name": "baker", "in": "path", "required": true, "description": "Baker address", "schema": { "type": "string" }, "x-position": 1 }, { "name": "cycle", "in": "path", "required": true, "description": "Rewards cycle", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "offset", "in": "query", "description": "Specifies how many delegators/stakers in the reward split should be skipped", "schema": { "type": "integer", "format": "int32", "default": 0 }, "x-position": 3 }, { "name": "limit", "in": "query", "description": "Maximum number of delegators/stakers to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 4 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RewardSplit" } } } } } } }, "/v1/rewards/split/{baker}/{cycle}/{member}": { "get": { "tags": [ "Rewards" ], "summary": "Get reward split member", "description": "Returns delegator/staker from the reward split for the specified cycle.", "operationId": "Rewards_GetRewardSplitMember", "parameters": [ { "name": "baker", "in": "path", "required": true, "description": "Baker address", "schema": { "type": "string" }, "x-position": 1 }, { "name": "cycle", "in": "path", "required": true, "description": "Reward split cycle", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "member", "in": "path", "required": true, "description": "Member address", "schema": { "type": "string" }, "x-position": 3 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SplitMember" } } } } } } }, "/v1/rights/count": { "get": { "tags": [ "Rights" ], "summary": "Get rights count", "description": "Returns the total number of stored rights.", "operationId": "Rights_GetCount", "parameters": [ { "name": "type", "in": "query", "description": "Filters rights by type (`baking`, `attestation`)", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BakingRightTypeParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "baking,attestation" }, { "name": "baker", "in": "query", "description": "Filters rights by baker", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "cycle", "in": "query", "description": "Filters rights by cycle", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters rights by level", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "slots", "in": "query", "description": "Filters rights by slots", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32NullParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "round", "in": "query", "description": "Filters rights by round", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32NullParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filters rights by status (`future`, `realized`, `missed`)", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BakingRightStatusParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "future,realized,uncovered,missed" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/rights": { "get": { "tags": [ "Rights" ], "summary": "Get rights", "description": "Returns a list of rights.", "operationId": "Rights_Get", "parameters": [ { "name": "type", "in": "query", "description": "Filters rights by type (`baking`, `attestation`)", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BakingRightTypeParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "baking,attestation" }, { "name": "baker", "in": "query", "description": "Filters rights by baker", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "cycle", "in": "query", "description": "Filters rights by cycle", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filters rights by level", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "slots", "in": "query", "description": "Filters rights by slots", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32NullParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "round", "in": "query", "description": "Filters rights by round", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32NullParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filters rights by status (`future`, `realized`, `missed`)", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BakingRightStatusParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "future,realized,uncovered,missed" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts rights by specified field. Supported fields: `level` (default).", "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", "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", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 11 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BakingRight" } } } } } } } }, "/v1/smart_rollups/count": { "get": { "tags": [ "SmartRollups" ], "summary": "Get smart rollups count", "description": "Returns a total number of smart rollups.", "operationId": "SmartRollups_GetSmartRollupsCount", "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/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "address", "in": "query", "description": "Filter by smart rollup address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AddressParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "creator", "in": "query", "description": "Filter by smart rollup creator. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "firstActivity", "in": "query", "description": "Filter by level of the block, where the rollup was first seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "firstActivityTime", "in": "query", "description": "Filter by timestamp of the block, where the rollup was first seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "lastActivity", "in": "query", "description": "Filter by level of the block, where the rollup was last seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "lastActivityTime", "in": "query", "description": "Filter by timestamp of the block, where the rollup was last seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/smart_rollups": { "get": { "tags": [ "SmartRollups" ], "summary": "Get smart rollups", "description": "Returns a list of smart rollups.", "operationId": "SmartRollups_GetSmartRollups", "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/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "address", "in": "query", "description": "Filter by smart rollup address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AddressParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "creator", "in": "query", "description": "Filter by smart rollup creator. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "firstActivity", "in": "query", "description": "Filter by level of the block, where the rollup was first seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "firstActivityTime", "in": "query", "description": "Filter by timestamp of the block, where the rollup was first seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "lastActivity", "in": "query", "description": "Filter by level of the block, where the rollup was last seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "lastActivityTime", "in": "query", "description": "Filter by timestamp of the block, where the rollup was last seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 7, "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": 8, "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": 9, "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": 10 }, { "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": 11, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmartRollup" } } } } } } } }, "/v1/smart_rollups/{address}": { "get": { "tags": [ "SmartRollups" ], "summary": "Get smart rollup by address", "description": "Returns a smart rollup with the specified address.", "operationId": "SmartRollups_GetSmartRollup", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Smart rollup address", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmartRollup" } } } } } } }, "/v1/smart_rollups/{address}/entrypoints": { "get": { "tags": [ "SmartRollups" ], "summary": "Get smart rollup entrypoints", "description": "Returns entrypoints of the specified smart rollup.", "operationId": "SmartRollups_GetEntrypoints", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Smart rollup address (starting with sr1)", "schema": { "type": "string" }, "x-position": 1 }, { "name": "all", "in": "query", "description": "If true, returns all entrypoints, including unused ones.\n Unused means that the entrypoint can be normalized to a more specific one.\n For example here `(or %entry1 (unit %entry2) (nat %entry3))` the `%entry1` is unused entrypoint\n because it can be normalized to `%entry2` or `%entry3`", "schema": { "type": "boolean", "default": false }, "x-position": 2 }, { "name": "json", "in": "query", "description": "Include parameters schema in human-readable JSON format", "schema": { "type": "boolean", "default": true }, "x-position": 3 }, { "name": "micheline", "in": "query", "description": "Include parameters schema in micheline format", "schema": { "type": "boolean", "default": false }, "x-position": 4 }, { "name": "michelson", "in": "query", "description": "Include parameters schema in michelson format", "schema": { "type": "boolean", "default": false }, "x-position": 5 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Entrypoint" } } } } } } } }, "/v1/smart_rollups/{address}/interface": { "get": { "tags": [ "SmartRollups" ], "summary": "Get JSON Schema [2020-12] interface for the smart rollup", "description": "Returns standard JSON Schema for smart rollup parameter.", "operationId": "SmartRollups_GetInterface", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Smart rollup address", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "nullable": true } } } } } } }, "/v1/smart_rollups/{address}/stakers": { "get": { "tags": [ "SmartRollups" ], "summary": "Get smart rollup stakers", "description": "Returns a list of smart rollup stakers.", "operationId": "SmartRollups_GetSmartRollupStakers", "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/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "address", "in": "path", "required": true, "description": "Filter by smart rollup staker address. \nClick on the parameter to expand more details.", "schema": { "$ref": "#/components/schemas/AddressParameter" }, "x-position": 2 }, { "name": "bondStatus", "in": "query", "description": "Filter by staker bond status (`active`, `returned`, or `lost`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SrBondStatusParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "active,returned,lost" }, { "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": 4, "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": 5, "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": 6 }, { "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": 7, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SrStaker" } } } } } } } }, "/v1/smart_rollups/commitments/count": { "get": { "tags": [ "SmartRollups" ], "summary": "Get smart rollup commitments count", "description": "Returns a total number of smart rollup commitments.", "operationId": "SmartRollups_GetSmartRollupCommitmentsCount", "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/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "initiator", "in": "query", "description": "Filter by initiator (an account published the commitment first). \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": "rollup", "in": "query", "description": "Filter by smart rollup. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "inboxLevel", "in": "query", "description": "Filter by inbox level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "hash", "in": "query", "description": "Filter by commitment hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Src1HashParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "firstLevel", "in": "query", "description": "Filter by level of the block, where the commitment was first seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "firstTime", "in": "query", "description": "Filter by timestamp of the block, where the commitment was first seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "lastLevel", "in": "query", "description": "Filter by level of the block, where the commitment was last seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "lastTime", "in": "query", "description": "Filter by timestamp of the block, where the commitment was last seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by commitment status (`pending`, `cemented`, `executed`, `refuted`, or `orphan`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SrCommitmentStatusParameter" } ] }, "x-position": 10, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "orphan,refuted,pending,cemented,executed" }, { "name": "predecessor.id", "in": "query", "description": "Filter by internal TzKT id. \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": "predecessor.hash", "in": "query", "description": "Filter by commitment hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Src1HashParameter" } ] }, "x-position": 12, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/smart_rollups/commitments": { "get": { "tags": [ "SmartRollups" ], "summary": "Get smart rollup commitments", "description": "Returns a list of smart rollup commitments.", "operationId": "SmartRollups_GetSmartRollupCommitments", "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/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "initiator", "in": "query", "description": "Filter by initiator (an account published the commitment first). \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": "rollup", "in": "query", "description": "Filter by smart rollup. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "inboxLevel", "in": "query", "description": "Filter by inbox level. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "hash", "in": "query", "description": "Filter by commitment hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Src1HashParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "firstLevel", "in": "query", "description": "Filter by level of the block, where the commitment was first seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "firstTime", "in": "query", "description": "Filter by timestamp of the block, where the commitment was first seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "lastLevel", "in": "query", "description": "Filter by level of the block, where the commitment was last seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "lastTime", "in": "query", "description": "Filter by timestamp of the block, where the commitment was last seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by commitment status (`pending`, `cemented`, `executed`, `refuted`, or `orphan`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SrCommitmentStatusParameter" } ] }, "x-position": 10, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "orphan,refuted,pending,cemented,executed" }, { "name": "predecessor.id", "in": "query", "description": "Filter by internal TzKT id. \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": "predecessor.hash", "in": "query", "description": "Filter by commitment hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Src1HashParameter" } ] }, "x-position": 12, "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": 13, "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": 14, "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": 15 }, { "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": 16, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SrCommitment" } } } } } } } }, "/v1/smart_rollups/games/count": { "get": { "tags": [ "SmartRollups" ], "summary": "Get smart rollup games count", "description": "Returns a total number of smart rollup refutation games.", "operationId": "SmartRollups_GetSmartRollupGamesCount", "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/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "rollup", "in": "query", "description": "Filter by smart rollup. \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": "initiator", "in": "query", "description": "Filter by initiator (who found a wrong commitment and started the refutation game). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "initiatorCommitment.id", "in": "query", "description": "Filter by internal TzKT id. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "initiatorCommitment.hash", "in": "query", "description": "Filter by commitment hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Src1HashParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "opponent", "in": "query", "description": "Filter by opponent (who was accused in publishing a wrong commitment). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "opponentCommitment.id", "in": "query", "description": "Filter by internal TzKT id. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "opponentCommitment.hash", "in": "query", "description": "Filter by commitment hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Src1HashParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "firstLevel", "in": "query", "description": "Filter by level of the block, where the refutation game was started. \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 of the block, where the refutation game was started. \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 refutation game was last updated. \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 of the block, where the refutation game was last updated. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 12, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/smart_rollups/games": { "get": { "tags": [ "SmartRollups" ], "summary": "Get smart rollup games", "description": "Returns a list of smart rollup refutation games.", "operationId": "SmartRollups_GetSmartRollupGames", "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/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "rollup", "in": "query", "description": "Filter by smart rollup. \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": "initiator", "in": "query", "description": "Filter by initiator (who found a wrong commitment and started the refutation game). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "initiatorCommitment.id", "in": "query", "description": "Filter by internal TzKT id. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "initiatorCommitment.hash", "in": "query", "description": "Filter by commitment hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Src1HashParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "opponent", "in": "query", "description": "Filter by opponent (who was accused in publishing a wrong commitment). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "opponentCommitment.id", "in": "query", "description": "Filter by internal TzKT id. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "opponentCommitment.hash", "in": "query", "description": "Filter by commitment hash. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Src1HashParameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "firstLevel", "in": "query", "description": "Filter by level of the block, where the refutation game was started. \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 of the block, where the refutation game was started. \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 refutation game was last updated. \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 of the block, where the refutation game was last updated. \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": "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": 13, "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": 14, "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": 15 }, { "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": 16, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SrGame" } } } } } } } }, "/v1/smart_rollups/inbox/count": { "get": { "tags": [ "SmartRollups" ], "summary": "Get inbox messages count", "description": "Returns a total number of smart rollup inbox messages.", "operationId": "SmartRollups_GetInboxMessagesCount", "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/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by level of the block, where the message was pushed. \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 of the block, where the message was pushed. \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": "type", "in": "query", "description": "Filter by inbox message type (`level_start`, `level_info`, `level_end`, `transfer`, `external`, `migration`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SrMessageTypeParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "level_start,level_info,level_end,transfer,external,migration" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/smart_rollups/inbox": { "get": { "tags": [ "SmartRollups" ], "summary": "Get inbox messages", "description": "Returns a list of smart rollup inbox messages.", "operationId": "SmartRollups_GetInboxMessages", "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/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by level of the block, where the message was pushed. \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 of the block, where the message was pushed. \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": "type", "in": "query", "description": "Filter by inbox message type (`level_start`, `level_info`, `level_end`, `transfer`, `external`, `migration`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SrMessageTypeParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "level_start,level_info,level_end,transfer,external,migration" }, { "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": 5, "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": 6, "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": 7 }, { "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": 8, "x-tzkt-extension": "query-parameter" }, { "name": "micheline", "in": "query", "description": "Format of smart rollup call parameters: `0` - JSON, `1` - JSON string, `2` - raw micheline, `3` - raw micheline string", "schema": { "default": "Json", "oneOf": [ { "$ref": "#/components/schemas/MichelineFormat" } ] }, "x-position": 9 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SrMessage" } } } } } } } }, "/v1/software": { "get": { "tags": [ "Software" ], "summary": "Get baker software", "description": "Returns a list of baker software.", "operationId": "Software_Get", "parameters": [ { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts delegators by specified field. Supported fields: `id` (default), `firstLevel`, `lastLevel`, `blocksCount`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 4 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Software" } } } } } } } }, "/v1/software/count": { "get": { "tags": [ "Software" ], "summary": "Get software count", "description": "Returns a number of software.", "operationId": "Software_GetCount", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/staking/updates/count": { "get": { "tags": [ "Staking" ], "summary": "Get staking updates count", "description": "Returns a total number of staking updates.", "operationId": "Staking_GetStakingUpdatesCount", "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/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by level of the block, where the staking update happened. \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 of the block, where the staking update happened. \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": "cycle", "in": "query", "description": "Filter by freezer or block cycle (depending on the update type). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "baker", "in": "query", "description": "Filter by related baker. \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": "staker", "in": "query", "description": "Filter by related staker. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "type", "in": "query", "description": "Filter by staking update type. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/StakingUpdateTypeParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "stake,unstake,restake,finalize,slash_staked,slash_unstaked" }, { "name": "amount", "in": "query", "description": "Filter by amount. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "pseudotokens", "in": "query", "description": "Filter by amount of staking pseudotokens minted or burnt. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BigIntegerNullableParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "roundingError", "in": "query", "description": "Filter by protocol rounding error. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64NullParameter" } ] }, "x-position": 10, "x-tzkt-extension": "query-parameter" }, { "name": "autostakingOpId", "in": "query", "description": "Filter by the ID of the related operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64NullParameter" } ] }, "x-position": 11, "x-tzkt-extension": "query-parameter" }, { "name": "stakingOpId", "in": "query", "description": "Filter by the ID of the related operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64NullParameter" } ] }, "x-position": 12, "x-tzkt-extension": "query-parameter" }, { "name": "delegationOpId", "in": "query", "description": "Filter by the ID of the related operation. \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": "doubleBakingOpId", "in": "query", "description": "Filter by the ID of the related operation. \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": "doubleConsensusOpId", "in": "query", "description": "Filter by the ID of the related operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64NullParameter" } ] }, "x-position": 15, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/staking/updates": { "get": { "tags": [ "Staking" ], "summary": "Get staking updates", "description": "Returns a list of staking updates.", "operationId": "Staking_GetStakingUpdates", "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/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "level", "in": "query", "description": "Filter by level of the block, where the staking update happened. \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 of the block, where the staking update happened. \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": "cycle", "in": "query", "description": "Filter by freezer or block cycle (depending on the update type). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "baker", "in": "query", "description": "Filter by related baker. \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": "staker", "in": "query", "description": "Filter by related staker. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "type", "in": "query", "description": "Filter by staking update type. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/StakingUpdateTypeParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "stake,unstake,restake,finalize,slash_staked,slash_unstaked" }, { "name": "amount", "in": "query", "description": "Filter by amount. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "pseudotokens", "in": "query", "description": "Filter by amount of staking pseudotokens minted or burnt. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BigIntegerNullableParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "roundingError", "in": "query", "description": "Filter by protocol rounding error. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64NullParameter" } ] }, "x-position": 10, "x-tzkt-extension": "query-parameter" }, { "name": "autostakingOpId", "in": "query", "description": "Filter by the ID of the related operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64NullParameter" } ] }, "x-position": 11, "x-tzkt-extension": "query-parameter" }, { "name": "stakingOpId", "in": "query", "description": "Filter by the ID of the related operation. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64NullParameter" } ] }, "x-position": 12, "x-tzkt-extension": "query-parameter" }, { "name": "delegationOpId", "in": "query", "description": "Filter by the ID of the related operation. \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": "doubleBakingOpId", "in": "query", "description": "Filter by the ID of the related operation. \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": "doubleConsensusOpId", "in": "query", "description": "Filter by the ID of the related operation. \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": "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/StakingUpdate" } } } } } } } }, "/v1/staking/unstake_requests/count": { "get": { "tags": [ "Staking" ], "summary": "Get unstake requests count", "description": "Returns a total number of unstake requests.", "operationId": "Staking_GetUnstakeRequestsCount", "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/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "cycle", "in": "query", "description": "Filter by cycle. \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": "baker", "in": "query", "description": "Filter by related baker. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "staker", "in": "query", "description": "Filter by related staker.\nIf staker is null, then it's aggregated unstaked deposits for the baker. \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": "requestedAmount", "in": "query", "description": "Filter by requested amount. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "restakedAmount", "in": "query", "description": "Filter by restaked amount. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "finalizedAmount", "in": "query", "description": "Filter by finalized amount. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "slashedAmount", "in": "query", "description": "Filter by slashed amount. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "roundingError", "in": "query", "description": "Filter by protocol rounding error. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64NullParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "actualAmount", "in": "query", "description": "Filter by actual amount. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 10, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by status. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/UnstakeRequestStatusParameter" } ] }, "x-position": 11, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "pending,finalizable,finalized" }, { "name": "updatesCount", "in": "query", "description": "Filter by staking updates count. \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": "firstLevel", "in": "query", "description": "Filter by level of the block where the unstake request was created. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 13, "x-tzkt-extension": "query-parameter" }, { "name": "firstTime", "in": "query", "description": "Filter by timestamp (ISO 8601) of the block where the unstake request was created. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 14, "x-tzkt-extension": "query-parameter" }, { "name": "lastLevel", "in": "query", "description": "Filter by level of the block where the unstake request was last updated. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 15, "x-tzkt-extension": "query-parameter" }, { "name": "lastTime", "in": "query", "description": "Filter by timestamp (ISO 8601) of the block where the unstake request was last updated. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 16, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/staking/unstake_requests": { "get": { "tags": [ "Staking" ], "summary": "Get unstake requests", "description": "Returns a list of unstake requests.", "operationId": "Staking_GetUnstakeRequests", "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/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "cycle", "in": "query", "description": "Filter by cycle. \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": "baker", "in": "query", "description": "Filter by related baker. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "staker", "in": "query", "description": "Filter by related staker.\nIf staker is null, then it's aggregated unstaked deposits for the baker. \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": "requestedAmount", "in": "query", "description": "Filter by requested amount. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "restakedAmount", "in": "query", "description": "Filter by restaked amount. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "finalizedAmount", "in": "query", "description": "Filter by finalized amount. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "slashedAmount", "in": "query", "description": "Filter by slashed amount. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 8, "x-tzkt-extension": "query-parameter" }, { "name": "roundingError", "in": "query", "description": "Filter by protocol rounding error. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64NullParameter" } ] }, "x-position": 9, "x-tzkt-extension": "query-parameter" }, { "name": "actualAmount", "in": "query", "description": "Filter by actual amount. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64Parameter" } ] }, "x-position": 10, "x-tzkt-extension": "query-parameter" }, { "name": "status", "in": "query", "description": "Filter by status. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/UnstakeRequestStatusParameter" } ] }, "x-position": 11, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "pending,finalizable,finalized" }, { "name": "updatesCount", "in": "query", "description": "Filter by staking updates count. \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": "firstLevel", "in": "query", "description": "Filter by level of the block where the unstake request was created. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 13, "x-tzkt-extension": "query-parameter" }, { "name": "firstTime", "in": "query", "description": "Filter by timestamp (ISO 8601) of the block where the unstake request was created. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 14, "x-tzkt-extension": "query-parameter" }, { "name": "lastLevel", "in": "query", "description": "Filter by level of the block where the unstake request was last updated. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 15, "x-tzkt-extension": "query-parameter" }, { "name": "lastTime", "in": "query", "description": "Filter by timestamp (ISO 8601) of the block where the unstake request was last updated. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 16, "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": 17, "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": 18, "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": 19 }, { "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": 20, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnstakeRequest" } } } } } } } }, "/v1/statistics": { "get": { "tags": [ "Statistics" ], "summary": "Get statistics", "description": "Returns a list of end-of-block statistics.", "operationId": "Statistics_Get", "parameters": [ { "name": "level", "in": "query", "description": "Filters statistics by level.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "timestamp", "in": "query", "description": "Filters statistics by timestamp.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts delegators by specified field. Supported fields: `id` (default), `level`, `cycle`, `date`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 6 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 7 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Statistics" } } } } } } } }, "/v1/statistics/daily": { "get": { "tags": [ "Statistics" ], "summary": "Get daily statistics", "description": "Returns a list of end-of-day statistics.", "operationId": "Statistics_GetDaily", "parameters": [ { "name": "date", "in": "query", "description": "Filters statistics by date.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DateTimeParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts delegators by specified field. Supported fields: `id` (default), `level`, `cycle`, `date`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 5 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 6 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Statistics" } } } } } } } }, "/v1/statistics/cyclic": { "get": { "tags": [ "Statistics" ], "summary": "Get cyclic statistics", "description": "Returns a list of end-of-cycle statistics.", "operationId": "Statistics_GetCyclic", "parameters": [ { "name": "cycle", "in": "query", "description": "Filters statistics by cycle.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts delegators by specified field. Supported fields: `id` (default), `level`, `cycle`, `date`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 5 }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 6 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Statistics" } } } } } } } }, "/v1/statistics/current": { "get": { "tags": [ "Statistics" ], "summary": "Get current statistics", "description": "Returns statistics at the end of a head block.", "operationId": "Statistics_GetCurrent", "parameters": [ { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select a single field, response will be a single value in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "quote", "in": "query", "description": "Comma-separated list of ticker symbols to inject historical prices into response", "schema": { "default": "None", "oneOf": [ { "$ref": "#/components/schemas/Symbols" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statistics" } } } } } } }, "/v1/tickets/count": { "get": { "tags": [ "Tickets" ], "summary": "Get tickets count", "description": "Returns a total number of tickets.", "operationId": "Tickets_GetTicketsCount", "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": "ticketer", "in": "query", "description": "Filter by ticketer 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": "rawType", "in": "query", "description": "Filter by ticket content type in Micheline format. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MichelineParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "rawContent", "in": "query", "description": "Filter by ticket content in Micheline format. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MichelineParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "content", "in": "query", "description": "Filter by ticket content in JSON format. \nNote, this parameter supports the following format: `content{.path?}{.mode?}=...`,\nso you can specify a path to a particular field to filter by (for example, `?content.color.in=red,green`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonParameter" } ] }, "x-position": 5, "x-tzkt-extension": "json-parameter" }, { "name": "typeHash", "in": "query", "description": "Filter by 32-bit hash of ticket content type. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "contentHash", "in": "query", "description": "Filter by 32-bit hash of ticket content. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "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": 8, "x-tzkt-extension": "query-parameter" }, { "name": "firstLevel", "in": "query", "description": "Filter by level of the block where the ticket was first seen. \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 ticket was first seen. \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 ticket 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 ticket was last seen. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimestampParameter" } ] }, "x-position": 12, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/tickets": { "get": { "tags": [ "Tickets" ], "summary": "Get tickets", "description": "Returns a list of tickets.", "operationId": "Tickets_GetTickets", "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": "ticketer", "in": "query", "description": "Filter by ticketer 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": "rawType", "in": "query", "description": "Filter by ticket content type in Micheline format. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MichelineParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "rawContent", "in": "query", "description": "Filter by ticket content in Micheline format. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MichelineParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "content", "in": "query", "description": "Filter by ticket content in JSON format. \nNote, this parameter supports the following format: `content{.path?}{.mode?}=...`,\nso you can specify a path to a particular field to filter by (for example, `?content.color.in=red,green`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonParameter" } ] }, "x-position": 5, "x-tzkt-extension": "json-parameter" }, { "name": "typeHash", "in": "query", "description": "Filter by 32-bit hash of ticket content type. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "contentHash", "in": "query", "description": "Filter by 32-bit hash of ticket content. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "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": 8, "x-tzkt-extension": "query-parameter" }, { "name": "firstLevel", "in": "query", "description": "Filter by level of the block where the ticket was first seen. \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 ticket was first seen. \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 ticket 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 ticket was last seen. \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": "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": 13, "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": 14, "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": 15 }, { "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": 16, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Ticket" } } } } } } } }, "/v1/tickets/balances/count": { "get": { "tags": [ "Tickets" ], "summary": "Get ticket balances count", "description": "Returns a total number of ticket balances.", "operationId": "Tickets_GetTicketBalancesCount", "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": "ticket.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": 2, "x-tzkt-extension": "query-parameter" }, { "name": "ticket.ticketer", "in": "query", "description": "Filter by ticketer address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "ticket.rawType", "in": "query", "description": "Filter by ticket content type in Micheline format. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MichelineParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "ticket.rawContent", "in": "query", "description": "Filter by ticket content in Micheline format. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MichelineParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "ticket.content", "in": "query", "description": "Filter by ticket content in JSON format. \nNote, this parameter supports the following format: `content{.path?}{.mode?}=...`,\nso you can specify a path to a particular field to filter by (for example, `?content.color.in=red,green`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonParameter" } ] }, "x-position": 6, "x-tzkt-extension": "json-parameter" }, { "name": "ticket.typeHash", "in": "query", "description": "Filter by 32-bit hash of ticket content type. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "ticket.contentHash", "in": "query", "description": "Filter by 32-bit hash of ticket content. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 8, "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": 9, "x-tzkt-extension": "query-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": 10, "x-tzkt-extension": "query-parameter" }, { "name": "transfersCount", "in": "query", "description": "Filter by number of transfers. \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": "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": 12, "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": 13, "x-tzkt-extension": "query-parameter" }, { "name": "lastLevel", "in": "query", "description": "Filter by level of the block where the balance was last changed. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 14, "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": 15, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/tickets/balances": { "get": { "tags": [ "Tickets" ], "summary": "Get ticket balances", "description": "Returns a list of ticket balances.", "operationId": "Tickets_GetTicketBalances", "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": "ticket.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": 2, "x-tzkt-extension": "query-parameter" }, { "name": "ticket.ticketer", "in": "query", "description": "Filter by ticketer address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "ticket.rawType", "in": "query", "description": "Filter by ticket content type in Micheline format. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MichelineParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "ticket.rawContent", "in": "query", "description": "Filter by ticket content in Micheline format. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MichelineParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "ticket.content", "in": "query", "description": "Filter by ticket content in JSON format. \nNote, this parameter supports the following format: `content{.path?}{.mode?}=...`,\nso you can specify a path to a particular field to filter by (for example, `?content.color.in=red,green`). \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/JsonParameter" } ] }, "x-position": 6, "x-tzkt-extension": "json-parameter" }, { "name": "ticket.typeHash", "in": "query", "description": "Filter by 32-bit hash of ticket content type. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "ticket.contentHash", "in": "query", "description": "Filter by 32-bit hash of ticket content. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 8, "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": 9, "x-tzkt-extension": "query-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": 10, "x-tzkt-extension": "query-parameter" }, { "name": "transfersCount", "in": "query", "description": "Filter by number of transfers. \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": "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": 12, "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": 13, "x-tzkt-extension": "query-parameter" }, { "name": "lastLevel", "in": "query", "description": "Filter by level of the block where the balance was last changed. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 14, "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": 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/TicketBalance" } } } } } } } }, "/v1/tickets/transfers/count": { "get": { "tags": [ "Tickets" ], "summary": "Get ticket transfers count", "description": "Returns the total number of ticket transfers.", "operationId": "Tickets_GetTicketTransfersCount", "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": "ticket.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": 4, "x-tzkt-extension": "query-parameter" }, { "name": "ticket.ticketer", "in": "query", "description": "Filter by ticketer 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": "ticket.rawType", "in": "query", "description": "Filter by ticket content type in Micheline format. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MichelineParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "ticket.rawContent", "in": "query", "description": "Filter by ticket content in Micheline format. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MichelineParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "ticket.content", "in": "query", "description": "Filter by ticket content in JSON format. \nNote, this parameter supports the following format: `content{.path?}{.mode?}=...`,\nso you can specify a path to a particular field to filter by (for example, `?content.color.in=red,green`). \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": "ticket.typeHash", "in": "query", "description": "Filter by 32-bit hash of ticket content type. \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": "ticket.contentHash", "in": "query", "description": "Filter by 32-bit hash of ticket content. \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": "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": 11, "x-tzkt-extension": "anyof-parameter", "x-tzkt-anyof-parameter": "from,to" }, { "name": "from", "in": "query", "description": "Filter by sender address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 12, "x-tzkt-extension": "query-parameter" }, { "name": "to", "in": "query", "description": "Filter by recepient address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 13, "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": 14, "x-tzkt-extension": "query-parameter" }, { "name": "transactionId", "in": "query", "description": "Filter by id of the transaction, caused the ticket 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": "transferTicketId", "in": "query", "description": "Filter by id of the transfer_ticket operation, caused the ticket transfer. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64NullParameter" } ] }, "x-position": 16, "x-tzkt-extension": "query-parameter" }, { "name": "smartRollupExecuteId", "in": "query", "description": "Filter by id of the smart_rollup_execute operation, caused the ticket transfer. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64NullParameter" } ] }, "x-position": 17, "x-tzkt-extension": "query-parameter" }, { "name": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 18 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/tickets/transfers": { "get": { "tags": [ "Tickets" ], "summary": "Get ticket transfers", "description": "Returns a list of ticket transfers.", "operationId": "Tickets_GetTicketTransfers", "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": "ticket.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": 4, "x-tzkt-extension": "query-parameter" }, { "name": "ticket.ticketer", "in": "query", "description": "Filter by ticketer 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": "ticket.rawType", "in": "query", "description": "Filter by ticket content type in Micheline format. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MichelineParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "ticket.rawContent", "in": "query", "description": "Filter by ticket content in Micheline format. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MichelineParameter" } ] }, "x-position": 7, "x-tzkt-extension": "query-parameter" }, { "name": "ticket.content", "in": "query", "description": "Filter by ticket content in JSON format. \nNote, this parameter supports the following format: `content{.path?}{.mode?}=...`,\nso you can specify a path to a particular field to filter by (for example, `?content.color.in=red,green`). \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": "ticket.typeHash", "in": "query", "description": "Filter by 32-bit hash of ticket content type. \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": "ticket.contentHash", "in": "query", "description": "Filter by 32-bit hash of ticket content. \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": "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": 11, "x-tzkt-extension": "anyof-parameter", "x-tzkt-anyof-parameter": "from,to" }, { "name": "from", "in": "query", "description": "Filter by sender address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 12, "x-tzkt-extension": "query-parameter" }, { "name": "to", "in": "query", "description": "Filter by recepient address. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AccountParameter" } ] }, "x-position": 13, "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": 14, "x-tzkt-extension": "query-parameter" }, { "name": "transactionId", "in": "query", "description": "Filter by id of the transaction, caused the ticket 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": "transferTicketId", "in": "query", "description": "Filter by id of the transfer_ticket operation, caused the ticket transfer. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64NullParameter" } ] }, "x-position": 16, "x-tzkt-extension": "query-parameter" }, { "name": "smartRollupExecuteId", "in": "query", "description": "Filter by id of the smart_rollup_execute operation, caused the ticket transfer. \nClick on the parameter to expand more details.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int64NullParameter" } ] }, "x-position": 17, "x-tzkt-extension": "query-parameter" }, { "name": "or.ColsAndVals", "in": "query", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ValueTupleOfStringAndListOfInteger" } }, "x-position": 18 }, { "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": 19, "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": 20, "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": 21 }, { "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": 22, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketTransfer" } } } } } } } }, "/v1/tickets/historical_balances/{level}": { "get": { "tags": [ "Tickets" ], "summary": "Get historical ticket balances", "description": "Returns a list of ticket balances at the end of the specified block.\nNote, this endpoint is quite heavy, therefore at least one of the filters\n(`account`, `ticket.id`, `ticket.ticketer`) must be specified.", "operationId": "Tickets_GetHistoricalTicketBalances", "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": "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": 2, "x-tzkt-extension": "query-parameter" }, { "name": "ticket.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": 3, "x-tzkt-extension": "query-parameter" }, { "name": "ticket.ticketer", "in": "query", "description": "Filter by ticketer 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": "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": 5, "x-tzkt-extension": "query-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": 6, "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": 7, "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": 8, "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": 9 }, { "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": 10, "x-tzkt-extension": "query-parameter" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketBalanceShort" } } } } } } } }, "/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.\nNote, this endpoint is quite heavy, therefore at least one of the filters\n(`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" } } } } } } } }, "/v1/voting/proposals/count": { "get": { "tags": [ "Voting" ], "summary": "Get proposals count", "description": "Returns the total number of protocol proposals.", "operationId": "Voting_GetProposalsCount", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/v1/voting/proposals": { "get": { "tags": [ "Voting" ], "summary": "Get proposals", "description": "Returns a list of protocol proposals.", "operationId": "Voting_GetProposals", "parameters": [ { "name": "hash", "in": "query", "description": "Filters proposals by hash", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ProtocolParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "epoch", "in": "query", "description": "Filters proposals by voting epoch", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts proposals by specified field. Supported fields: `id` (default), `upvotes`, `votingPower`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 6 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Proposal" } } } } } } } }, "/v1/voting/proposals/{hash}": { "get": { "tags": [ "Voting" ], "summary": "Get proposal by hash", "description": "Returns the most recent protocol proposal with the specified hash.", "operationId": "Voting_GetProposalByHash", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Proposal hash", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Proposal" } } } } } } }, "/v1/voting/periods": { "get": { "tags": [ "Voting" ], "summary": "Get voting periods", "description": "Returns a list of voting periods.", "operationId": "Voting_GetPeriods", "parameters": [ { "name": "firstLevel", "in": "query", "description": "Filter by level of the first block of the period.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter" }, { "name": "lastLevel", "in": "query", "description": "Filter by level of the last block of the period.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "epoch", "in": "query", "description": "Filters by voting epoch", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Int32Parameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "select", "in": "query", "description": "Specify comma-separated list of fields to include into response or leave it undefined to return full object. If you select single field, response will be an array of values in both `.fields` and `.values` modes.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "sort", "in": "query", "description": "Sorts voting periods by specified field. Supported fields: `id` (default).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 5, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 6, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 7 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VotingPeriod" } } } } } } } }, "/v1/voting/periods/{index}": { "get": { "tags": [ "Voting" ], "summary": "Get voting period by index", "description": "Returns a voting period at the specified index.", "operationId": "Voting_GetPeriod", "parameters": [ { "name": "index", "in": "path", "required": true, "description": "Voting period index starting from zero", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VotingPeriod" } } } } } } }, "/v1/voting/periods/current": { "get": { "tags": [ "Voting" ], "summary": "Get current voting period", "description": "Returns current voting period.", "operationId": "Voting_GetCurrentPeriod", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VotingPeriod" } } } } } } }, "/v1/voting/periods/{index}/voters": { "get": { "tags": [ "Voting" ], "summary": "Get period voters", "description": "Returns voters from the voting period at the specified index.", "operationId": "Voting_GetPeriodVoters", "parameters": [ { "name": "index", "in": "path", "required": true, "description": "Voting period index starting from zero", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "status", "in": "query", "description": "Filters voters by status (`none`, `upvoted`, `voted_yay`, `voted_nay`, `voted_pass`)", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VoterStatusParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "none,upvoted,voted_yay,voted_nay,voted_pass" }, { "name": "sort", "in": "query", "description": "Sorts voters by specified field. Supported fields: `id` (default), `votingPower`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 4, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 5 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VoterSnapshot" } } } } } } } }, "/v1/voting/periods/{index}/voters/{address}": { "get": { "tags": [ "Voting" ], "summary": "Get period voter", "description": "Returns a voter with the specified address from the voting period at the specified index.", "operationId": "Voting_GetPeriodVoter", "parameters": [ { "name": "index", "in": "path", "required": true, "description": "Voting period index starting from zero", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 }, { "name": "address", "in": "path", "required": true, "description": "Voter address", "schema": { "type": "string" }, "x-position": 2 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoterSnapshot" } } } } } } }, "/v1/voting/periods/current/voters": { "get": { "tags": [ "Voting" ], "summary": "Get current period voters", "description": "Returns voters from the current period.", "operationId": "Voting_GetPeriodVoters2", "parameters": [ { "name": "status", "in": "query", "description": "Filters voters by status (`none`, `upvoted`, `voted_yay`, `voted_nay`, `voted_pass`)", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/VoterStatusParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "none,upvoted,voted_yay,voted_nay,voted_pass" }, { "name": "sort", "in": "query", "description": "Sorts voters by specified field. Supported fields: `id` (default), `votingPower`.", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 4 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VoterSnapshot" } } } } } } } }, "/v1/voting/periods/current/voters/{address}": { "get": { "tags": [ "Voting" ], "summary": "Get current period voter", "description": "Returns a voter with the specified address from the current period.", "operationId": "Voting_GetPeriodVoter2", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Voter address", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoterSnapshot" } } } } } } }, "/v1/voting/epochs": { "get": { "tags": [ "Voting" ], "summary": "Get voting epochs", "description": "Returns a list of voting epochs.", "operationId": "Voting_GetEpochs", "parameters": [ { "name": "status", "in": "query", "description": "Filter by voting epoch status (`no_proposals`, `voting`, `completed`, `failed`).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/EpochStatusParameter" } ] }, "x-position": 1, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "no_proposals,voting,completed,failed" }, { "name": "sort", "in": "query", "description": "Sorts voting epochs by specified field. Supported fields: `index` (default).", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SortParameter" } ] }, "x-position": 2, "x-tzkt-extension": "query-parameter" }, { "name": "offset", "in": "query", "description": "Specifies which or how many items should be skipped", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OffsetParameter" } ] }, "x-position": 3, "x-tzkt-extension": "query-parameter" }, { "name": "limit", "in": "query", "description": "Maximum number of items to return", "schema": { "type": "integer", "format": "int32", "default": 100, "maximum": 10000.0, "minimum": 0.0 }, "x-position": 4 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VotingEpoch" } } } } } } } }, "/v1/voting/epochs/{index}": { "get": { "tags": [ "Voting" ], "summary": "Get voting epoch by index", "description": "Returns a voting epoch at the specified index.", "operationId": "Voting_GetEpoch", "parameters": [ { "name": "index", "in": "path", "required": true, "description": "Voting epoch index starting from zero", "schema": { "type": "integer", "format": "int32" }, "x-position": 1 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VotingEpoch" } } } } } } }, "/v1/voting/epochs/current": { "get": { "tags": [ "Voting" ], "summary": "Get current voting epoch", "description": "Returns the current voting epoch", "operationId": "Voting_GetCurrentEpoch", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VotingEpoch" } } } } } } }, "/v1/voting/epochs/latest_voting": { "get": { "tags": [ "Voting" ], "summary": "Get latest voting", "description": "Returns the latest epoch with at least one proposal", "operationId": "Voting_GetLatestVoting", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VotingEpoch" } } } } } } } }, "components": { "schemas": { "Account": { "type": "object", "discriminator": { "propertyName": "type", "mapping": { "user": "#/components/schemas/User", "delegate": "#/components/schemas/Delegate", "contract": "#/components/schemas/Contract", "ghost": "#/components/schemas/Ghost", "rollup": "#/components/schemas/Rollup", "smart_rollup": "#/components/schemas/SmartRollup", "empty": "#/components/schemas/EmptyAccount" } }, "x-abstract": true, "additionalProperties": false, "required": [ "type" ], "properties": { "type": { "type": "string", "description": "Type of the account (`user` - simple wallet account, `delegate` - account, registered as a delegate (baker),\n`contract` - smart contract programmable account, `ghost` - non-existent contract, `empty` - account hasn't appeared in the blockchain yet,\n`rollup` - transactional optimistic rollup, `smart_rollup` - smart contract optimistic rollup)" }, "address": { "type": "string" } } }, "User": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT id", "format": "int32" }, "type": { "type": "string" }, "address": { "type": "string", "description": "Public key hash of the account" }, "alias": { "type": "string", "description": "Name of the project behind the account or account description", "nullable": true }, "publicKey": { "type": "string", "description": "Base58 representation of account's public key, revealed by the account", "nullable": true }, "revealed": { "type": "boolean", "description": "Public key revelation status. Unrevealed account can't send manager operation (transaction, origination etc.)" }, "balance": { "type": "integer", "description": "Account balance", "format": "int64" }, "rollupBonds": { "type": "integer", "description": "Amount of tx rollup commitment bonds (micro tez)", "format": "int64" }, "smartRollupBonds": { "type": "integer", "description": "Amount of smart rollup commitment bonds (micro tez)", "format": "int64" }, "stakedBalance": { "type": "integer", "description": "Amount staked with the selected baker (micro tez).\nLike delegated amount, except for it is frozen and can be slashed.", "format": "int64" }, "stakedPseudotokens": { "type": "string", "description": "Amount of \"pseudo-tokens\" received after staking. These pseudotokens are used for unstaking.", "nullable": true }, "unstakedBalance": { "type": "integer", "description": "Amount that was unstaked, but not yet finalized (i.e. it is still frozen) (micro tez)", "format": "int64" }, "unstakedBaker": { "description": "Information about the baker, for which there are pending unstake requests", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "delegate": { "description": "Information about the current delegate of the account. `null` if it's not delegated", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DelegateInfo" } ] }, "delegationLevel": { "type": "integer", "description": "Block height of latest delegation. `null` if it's not delegated", "format": "int32", "nullable": true }, "delegationTime": { "type": "string", "description": "Block datetime of latest delegation (ISO 8601, e.g. `2020-02-20T02:40:57Z`). `null` if it's not delegated", "format": "date-time", "nullable": true }, "numContracts": { "type": "integer", "description": "Number of contracts, created (originated) and/or managed by the account", "format": "int32" }, "rollupsCount": { "type": "integer", "description": "Number of tx rollups, created (originated) by the account", "format": "int32" }, "smartRollupsCount": { "type": "integer", "description": "Number of smart rollups, created (originated) by the account", "format": "int32" }, "activeTokensCount": { "type": "integer", "description": "Number of account tokens with non-zero balances", "format": "int32" }, "tokenBalancesCount": { "type": "integer", "description": "Number of tokens the account ever had", "format": "int32" }, "tokenTransfersCount": { "type": "integer", "description": "Number of token transfers from/to the account", "format": "int32" }, "activeTicketsCount": { "type": "integer", "description": "Number of tickets the account owns.", "format": "int32" }, "ticketBalancesCount": { "type": "integer", "description": "Number of tickets the account ever owned.", "format": "int32" }, "ticketTransfersCount": { "type": "integer", "description": "Number of ticket transfers from/to the account.", "format": "int32" }, "numActivations": { "type": "integer", "description": "Number of account activation operations. Are used to activate accounts that were recommended allocations of\ntezos tokens for donations to the Tezos Foundation’s fundraiser", "format": "int32" }, "numDelegations": { "type": "integer", "description": "Number of delegation operations, related to the account", "format": "int32" }, "numOriginations": { "type": "integer", "description": "Number of all origination (deployment / contract creation) operations, related to the account", "format": "int32" }, "numTransactions": { "type": "integer", "description": "Number of all transaction (tez transfer) operations, related to the account", "format": "int32" }, "numReveals": { "type": "integer", "description": "Number of reveal (is used to reveal the public key associated with an account) operations of the contract", "format": "int32" }, "numRegisterConstants": { "type": "integer", "description": "Number of register global constant operations sent by the account", "format": "int32" }, "numSetDepositsLimits": { "type": "integer", "description": "Number of set deposits limit operations sent by the account", "format": "int32" }, "numMigrations": { "type": "integer", "description": "Number of migration (result of the context (database) migration during a protocol update) operations,\nrelated to the account (synthetic type) ", "format": "int32" }, "txRollupOriginationCount": { "type": "integer", "description": "Number of tx rollup origination operations sent by the account", "format": "int32" }, "txRollupSubmitBatchCount": { "type": "integer", "description": "Number of tx rollup submit batch operations sent by the account", "format": "int32" }, "txRollupCommitCount": { "type": "integer", "description": "Number of tx rollup commit operations sent by the account", "format": "int32" }, "txRollupReturnBondCount": { "type": "integer", "description": "Number of tx rollup return bond operations sent by the account", "format": "int32" }, "txRollupFinalizeCommitmentCount": { "type": "integer", "description": "Number of tx rollup finalize commitment operations sent by the account", "format": "int32" }, "txRollupRemoveCommitmentCount": { "type": "integer", "description": "Number of tx rollup remove commitment operations sent by the account", "format": "int32" }, "txRollupRejectionCount": { "type": "integer", "description": "Number of tx rollup rejection operations sent by the account", "format": "int32" }, "txRollupDispatchTicketsCount": { "type": "integer", "description": "Number of tx rollup dispatch tickets operations sent by the account", "format": "int32" }, "transferTicketCount": { "type": "integer", "description": "Number of transfer ticket operations sent by the account", "format": "int32" }, "increasePaidStorageCount": { "type": "integer", "description": "Number of `increase_paid_storage` operations sent by the account", "format": "int32" }, "drainDelegateCount": { "type": "integer", "description": "Number of `drain_delegate` operations related to the account", "format": "int32" }, "smartRollupAddMessagesCount": { "type": "integer", "description": "Number of `smart_rollup_add_messages` operations related to the account", "format": "int32" }, "smartRollupCementCount": { "type": "integer", "description": "Number of `smart_rollup_cement` operations related to the account", "format": "int32" }, "smartRollupExecuteCount": { "type": "integer", "description": "Number of `smart_rollup_execute_outbox_message` operations related to the account", "format": "int32" }, "smartRollupOriginateCount": { "type": "integer", "description": "Number of `smart_rollup_originate` operations related to the account", "format": "int32" }, "smartRollupPublishCount": { "type": "integer", "description": "Number of `smart_rollup_publish` operations related to the account", "format": "int32" }, "smartRollupRecoverBondCount": { "type": "integer", "description": "Number of `smart_rollup_recover_bond` operations related to the account", "format": "int32" }, "smartRollupRefuteCount": { "type": "integer", "description": "Number of `smart_rollup_refute` operations related to the account", "format": "int32" }, "refutationGamesCount": { "type": "integer", "description": "Number of smart rollup refutation games related to the account", "format": "int32" }, "activeRefutationGamesCount": { "type": "integer", "description": "Number of active smart rollup refutation games related to the account", "format": "int32" }, "stakingOpsCount": { "type": "integer", "description": "Number of staking operations related to the account", "format": "int32" }, "stakingUpdatesCount": { "type": "integer", "description": "Number of staking updates related to the account", "format": "int32" }, "setDelegateParametersOpsCount": { "type": "integer", "description": "Number of set delegate parameters operations related to the account", "format": "int32" }, "dalPublishCommitmentOpsCount": { "type": "integer", "description": "Number of DAL publish commitment operations related to the account", "format": "int32" }, "firstActivity": { "type": "integer", "description": "Block height of the first operation, related to the account", "format": "int32", "nullable": true }, "firstActivityTime": { "type": "string", "description": "Block datetime of the first operation, related to the account (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time", "nullable": true }, "lastActivity": { "type": "integer", "description": "Height of the block in which the account state was changed last time", "format": "int32", "nullable": true }, "lastActivityTime": { "type": "string", "description": "Datetime of the block in which the account state was changed last time (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time", "nullable": true }, "extras": { "description": "Off-chain extras", "nullable": true } } } ] }, "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)." } } }, "DelegateInfo": { "type": "object", "additionalProperties": false, "properties": { "alias": { "type": "string", "description": "Name of the baking service", "nullable": true }, "address": { "type": "string", "description": "Public key hash of the delegate (baker)" }, "active": { "type": "boolean", "description": "Delegation status (`true` - active, `false` - deactivated)" } } }, "Delegate": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT id", "format": "int32" }, "type": { "type": "string", "description": "Type of the account, `delegate` - account, registered as a delegate (baker)" }, "address": { "type": "string", "description": "Public key hash of the delegate's main key" }, "consensusAddress": { "type": "string", "description": "Public key hash of the delegate's consensus key", "nullable": true }, "companionAddress": { "type": "string", "description": "Public key hash of the delegate's companion key", "nullable": true }, "active": { "type": "boolean", "description": "Delegation status (`true` - active, `false` - deactivated)" }, "alias": { "type": "string", "description": "Name of the baking service", "nullable": true }, "publicKey": { "type": "string", "description": "Public key of the delegate (baker)" }, "revealed": { "type": "boolean", "description": "Public key revelation status. Unrevealed account can't send manager operation (transaction, origination etc.)" }, "balance": { "type": "integer", "description": "Total balance of the delegate (baker), including spendable and frozen funds (micro tez)", "format": "int64" }, "rollupBonds": { "type": "integer", "description": "Amount of tx rollup commitment bonds (micro tez)", "format": "int64" }, "smartRollupBonds": { "type": "integer", "description": "Amount of smart rollup commitment bonds (micro tez)", "format": "int64" }, "stakedBalance": { "type": "integer", "description": "Amount staked from the own balance (micro tez).\nLike delegated amount, except for it is frozen and can be slashed.", "format": "int64" }, "unstakedBalance": { "type": "integer", "description": "Amount that was unstaked, but not yet finalized (i.e. it is still frozen) (micro tez).", "format": "int64" }, "unstakedBaker": { "description": "Information about the baker, for which there are pending unstake requests.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "externalStakedBalance": { "type": "integer", "description": "Amount staked from external stakers (micro tez).\nLike delegated amount, except for it is frozen and can be slashed.", "format": "int64" }, "externalUnstakedBalance": { "type": "integer", "description": "Amount that was unstaked by external stakers, but not yet finalized (i.e. it is still frozen) (micro tez).", "format": "int64" }, "roundingError": { "type": "integer", "description": "Amount that was lost due to inconsistend rounding introduced in Oxford (micro tez).", "format": "int64" }, "totalStakedBalance": { "type": "integer", "description": "Total staked balance, which is `stakedBalance + externalStakedBalance`.", "format": "int64" }, "issuedPseudotokens": { "type": "string", "description": "Total amount of issued \"pseudo-tokens\". These pseudotokens are used for unstaking.", "nullable": true }, "stakersCount": { "type": "integer", "description": "Number of external stakers.", "format": "int32" }, "frozenDepositLimit": { "type": "integer", "description": "Configured max amount allowed to be locked as a security deposit (micro tez)", "format": "int64", "nullable": true }, "limitOfStakingOverBaking": { "type": "integer", "description": "This parameter determines the maximum portion (millionth) of external stake by stakers over the baker's own staked funds.", "format": "int64", "nullable": true }, "edgeOfBakingOverStaking": { "type": "integer", "description": "This parameter determines the fraction (billionth) of the rewards that accrue to the baker's liquid spendable balance — the remainder accrues to frozen stakes.", "format": "int64", "nullable": true }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "activationLevel": { "type": "integer", "description": "Block height when delegate (baker) was registered as a baker last time", "format": "int32" }, "activationTime": { "type": "string", "description": "Block datetime when delegate (baker) was registered as a baker last time (ISO 8601, e.g. 2019-11-31)", "format": "date-time" }, "deactivationLevel": { "type": "integer", "description": "Block height when delegate (baker) was deactivated as a baker because of lack of funds or inactivity", "format": "int32", "nullable": true }, "deactivationTime": { "type": "string", "description": "Block datetime when delegate (baker) was deactivated as a baker because of lack of funds or inactivity (ISO 8601, e.g. 2019-11-31)", "format": "date-time", "nullable": true }, "bakingPower": { "type": "integer", "description": "Current baking power", "format": "int64" }, "votingPower": { "type": "integer", "description": "Current voting power", "format": "int64" }, "ownDelegatedBalance": { "type": "integer", "description": "Amount delegated from the own balance (micro tez).", "format": "int64" }, "externalDelegatedBalance": { "type": "integer", "description": "Amount delegated from the external delegators (micro tez).", "format": "int64" }, "numContracts": { "type": "integer", "description": "Number of contracts, created (originated) and/or managed by the delegate (baker)", "format": "int32" }, "rollupsCount": { "type": "integer", "description": "Number of tx rollups, created (originated) by the account", "format": "int32" }, "smartRollupsCount": { "type": "integer", "description": "Number of smart rollups, created (originated) by the account", "format": "int32" }, "activeTokensCount": { "type": "integer", "description": "Number of account tokens with non-zero balances", "format": "int32" }, "tokenBalancesCount": { "type": "integer", "description": "Number of tokens the account ever had", "format": "int32" }, "tokenTransfersCount": { "type": "integer", "description": "Number of token transfers from/to the account", "format": "int32" }, "activeTicketsCount": { "type": "integer", "description": "Number of tickets the account owns.", "format": "int32" }, "ticketBalancesCount": { "type": "integer", "description": "Number of tickets the account ever owned.", "format": "int32" }, "ticketTransfersCount": { "type": "integer", "description": "Number of ticket transfers from/to the account.", "format": "int32" }, "numDelegators": { "type": "integer", "description": "Number of current delegators (accounts, delegated their funds) of the delegate (baker)", "format": "int32" }, "numBlocks": { "type": "integer", "description": "Number of baked (validated) blocks all the time by the delegate (baker)", "format": "int32" }, "numAttestations": { "type": "integer", "description": "Number of given attestations (approvals) by the delegate (baker)", "format": "int32" }, "numPreattestations": { "type": "integer", "description": "Number of given preattestations (approvals) by the delegate (baker)", "format": "int32" }, "numBallots": { "type": "integer", "description": "Number of submitted by the delegate ballots during a voting period", "format": "int32" }, "numProposals": { "type": "integer", "description": "Number of submitted (upvoted) by the delegate proposals during a proposal period", "format": "int32" }, "numActivations": { "type": "integer", "description": "Number of account activation operations. Are used to activate accounts that were recommended allocations of\ntezos tokens for donations to the Tezos Foundation’s fundraiser", "format": "int32" }, "numDoubleBaking": { "type": "integer", "description": "Number of double baking (baking two different blocks at the same height) evidence operations,\nincluded in blocks, baked (validated) by the delegate", "format": "int32" }, "numDoubleConsensus": { "type": "integer", "description": "Number of double consensus (attestation or preattestation of two different blocks at the same block height) evidence operations,\nincluded in blocks, baked (validated) by the delegate", "format": "int32" }, "numNonceRevelations": { "type": "integer", "description": "Number of seed nonce revelation (are used by the blockchain to create randomness) operations provided by the delegate", "format": "int32" }, "vdfRevelationsCount": { "type": "integer", "description": "Number of `vdf_revelation` operations included into blocks by the delegate", "format": "int32" }, "numRevelationPenalties": { "type": "integer", "description": "Number of operations for all time in which rewards were lost due to unrevealed seed nonces by the delegate (synthetic type)", "format": "int32" }, "numAttestationRewards": { "type": "integer", "description": "Number of attestation rewards received at the end of cycles (synthetic type)", "format": "int32" }, "numDelegations": { "type": "integer", "description": "Number of all delegation related operations (new delegator, left delegator, registration as a baker),\nrelated to the delegate (baker) ", "format": "int32" }, "numOriginations": { "type": "integer", "description": "Number of all origination (deployment / contract creation) operations, related to the delegate (baker)", "format": "int32" }, "numTransactions": { "type": "integer", "description": "Number of all transaction (tez transfer) operations, related to the delegate (baker)", "format": "int32" }, "numReveals": { "type": "integer", "description": "Number of reveal (is used to reveal the public key associated with an account) operations of the delegate (baker)", "format": "int32" }, "numRegisterConstants": { "type": "integer", "description": "Number of register global constant operations sent by the baker", "format": "int32" }, "numSetDepositsLimits": { "type": "integer", "description": "Number of set deposits limit operations sent by the baker", "format": "int32" }, "numMigrations": { "type": "integer", "description": "Number of migration (result of the context (database) migration during a protocol update) operations,\nrelated to the delegate (synthetic type) ", "format": "int32" }, "txRollupOriginationCount": { "type": "integer", "description": "Number of tx rollup origination operations sent by the account", "format": "int32" }, "txRollupSubmitBatchCount": { "type": "integer", "description": "Number of tx rollup submit batch operations sent by the account", "format": "int32" }, "txRollupCommitCount": { "type": "integer", "description": "Number of tx rollup commit operations sent by the account", "format": "int32" }, "txRollupReturnBondCount": { "type": "integer", "description": "Number of tx rollup return bond operations sent by the account", "format": "int32" }, "txRollupFinalizeCommitmentCount": { "type": "integer", "description": "Number of tx rollup finalize commitment operations sent by the account", "format": "int32" }, "txRollupRemoveCommitmentCount": { "type": "integer", "description": "Number of tx rollup remove commitment operations sent by the account", "format": "int32" }, "txRollupRejectionCount": { "type": "integer", "description": "Number of tx rollup rejection operations sent by the account", "format": "int32" }, "txRollupDispatchTicketsCount": { "type": "integer", "description": "Number of tx rollup dispatch tickets operations sent by the account", "format": "int32" }, "transferTicketCount": { "type": "integer", "description": "Number of transfer ticket operations sent by the account", "format": "int32" }, "increasePaidStorageCount": { "type": "integer", "description": "Number of `increase_paid_storage` operations sent by the account", "format": "int32" }, "updateSecondaryKeyCount": { "type": "integer", "description": "Number of `update_secondary_key` operations sent by the account", "format": "int32" }, "drainDelegateCount": { "type": "integer", "description": "Number of `drain_delegate` operations related to the account", "format": "int32" }, "smartRollupAddMessagesCount": { "type": "integer", "description": "Number of `smart_rollup_add_messages` operations related to the account", "format": "int32" }, "smartRollupCementCount": { "type": "integer", "description": "Number of `smart_rollup_cement` operations related to the account", "format": "int32" }, "smartRollupExecuteCount": { "type": "integer", "description": "Number of `smart_rollup_execute_outbox_message` operations related to the account", "format": "int32" }, "smartRollupOriginateCount": { "type": "integer", "description": "Number of `smart_rollup_originate` operations related to the account", "format": "int32" }, "smartRollupPublishCount": { "type": "integer", "description": "Number of `smart_rollup_publish` operations related to the account", "format": "int32" }, "smartRollupRecoverBondCount": { "type": "integer", "description": "Number of `smart_rollup_recover_bond` operations related to the account", "format": "int32" }, "smartRollupRefuteCount": { "type": "integer", "description": "Number of `smart_rollup_refute` operations related to the account", "format": "int32" }, "refutationGamesCount": { "type": "integer", "description": "Number of smart rollup refutation games related to the account", "format": "int32" }, "activeRefutationGamesCount": { "type": "integer", "description": "Number of active smart rollup refutation games related to the account", "format": "int32" }, "stakingOpsCount": { "type": "integer", "description": "Number of staking operations related to the account", "format": "int32" }, "autostakingOpsCount": { "type": "integer", "description": "Number of autostaking operations related to the account", "format": "int32" }, "stakingUpdatesCount": { "type": "integer", "description": "Number of staking updates related to the account", "format": "int32" }, "setDelegateParametersOpsCount": { "type": "integer", "description": "Number of set delegate parameters operations related to the account", "format": "int32" }, "dalPublishCommitmentOpsCount": { "type": "integer", "description": "Number of DAL publish commitment operations related to the account", "format": "int32" }, "dalEntrapmentEvidenceOpsCount": { "type": "integer", "description": "Number of DAL entrapment evidences related to the account", "format": "int32" }, "dalAttestationRewardsCount": { "type": "integer", "description": "Number of DAL attestation rewards related to the account", "format": "int32" }, "firstActivity": { "type": "integer", "description": "Block height of the first operation, related to the delegate (baker)", "format": "int32" }, "firstActivityTime": { "type": "string", "description": "Block datetime of the first operation, related to the delegate (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "lastActivity": { "type": "integer", "description": "Height of the block in which the account state was changed last time", "format": "int32" }, "lastActivityTime": { "type": "string", "description": "Datetime of the block in which the account state was changed last time (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "extras": { "description": "Off-chain extras", "nullable": true }, "software": { "description": "Last seen baker's software", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SoftwareAlias" } ] }, "softwareUpdateLevel": { "type": "integer", "description": "Level of the first block baked by the baker with the current software version", "format": "int32", "nullable": true }, "softwareUpdateTime": { "type": "string", "description": "Datetime of the first block baked by the baker with the current software version", "format": "date-time", "nullable": true }, "stakingBalance": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "delegatedBalance": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "updateConsensusKeyCount": { "type": "integer", "description": "**DEPRECATED**", "format": "int32" }, "numEndorsements": { "type": "integer", "description": "**DEPRECATED**", "format": "int32" }, "numPreendorsements": { "type": "integer", "description": "**DEPRECATED**", "format": "int32" }, "numDoubleEndorsing": { "type": "integer", "description": "**DEPRECATED**", "format": "int32" }, "numDoublePreendorsing": { "type": "integer", "description": "**DEPRECATED**", "format": "int32" }, "numEndorsingRewards": { "type": "integer", "description": "**DEPRECATED**", "format": "int32" } } } ] }, "SoftwareAlias": { "type": "object", "additionalProperties": false, "properties": { "version": { "type": "string", "description": "Software version (commit tag)" }, "date": { "type": "string", "description": "Date of the commit or when the software was first seen", "format": "date-time" } } }, "Contract": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT id. \n**[sortable]**", "format": "int32" }, "type": { "type": "string", "description": "Type of the account, `contract` - smart contract programmable account." }, "address": { "type": "string", "description": "Public key hash of the contract" }, "kind": { "type": "string", "description": "Kind of the contract (`delegator_contract` or `smart_contract`),\nwhere `delegator_contract` - manager.tz smart contract for delegation purpose only." }, "tzips": { "type": "array", "description": "List of implemented standards (TZIPs).", "nullable": true, "items": { "type": "string" } }, "alias": { "type": "string", "description": "Name of the project behind the contract or contract description.", "nullable": true }, "balance": { "type": "integer", "description": "Contract balance (micro tez). \n**[sortable]**", "format": "int64" }, "creator": { "description": "Information about the account, which has deployed the contract to the blockchain. \nClick on the field to expand more details.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "delegate": { "description": "Information about the current delegate of the contract. `null` if it's not delegated. \nClick on the field to expand more details.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DelegateInfo" } ] }, "delegationLevel": { "type": "integer", "description": "Block height of latest delegation. `null` if it's not delegated.", "format": "int32", "nullable": true }, "delegationTime": { "type": "string", "description": "Block datetime of latest delegation (ISO 8601, e.g. `2020-02-20T02:40:57Z`). `null` if it's not delegated.", "format": "date-time", "nullable": true }, "numContracts": { "type": "integer", "description": "Number of contracts, created (originated) and/or managed by the contract.", "format": "int32" }, "tokensCount": { "type": "integer", "description": "Number of tokens minted in the contract.", "format": "int32" }, "activeTokensCount": { "type": "integer", "description": "Number of account tokens with non-zero balances.", "format": "int32" }, "tokenBalancesCount": { "type": "integer", "description": "Number of tokens the account ever had.", "format": "int32" }, "tokenTransfersCount": { "type": "integer", "description": "Number of token transfers from/to the account.", "format": "int32" }, "ticketsCount": { "type": "integer", "description": "Number of tickets minted in the contract.", "format": "int32" }, "activeTicketsCount": { "type": "integer", "description": "Number of tickets the account owns.", "format": "int32" }, "ticketBalancesCount": { "type": "integer", "description": "Number of tickets the account ever owned.", "format": "int32" }, "ticketTransfersCount": { "type": "integer", "description": "Number of ticket transfers from/to the account.", "format": "int32" }, "numDelegations": { "type": "integer", "description": "Number of delegation operations of the contract.", "format": "int32" }, "numOriginations": { "type": "integer", "description": "Number of origination (deployment / contract creation) operations, related the contract.", "format": "int32" }, "numTransactions": { "type": "integer", "description": "Number of transaction (transfer) operations, related to the contract. \n**[sortable]**", "format": "int32" }, "numReveals": { "type": "integer", "description": "Number of reveal (is used to reveal the public key associated with an account) operations of the contract.", "format": "int32" }, "numMigrations": { "type": "integer", "description": "Number of migration (result of the context (database) migration during a protocol update) operations.\nrelated to the contract (synthetic type).", "format": "int32" }, "transferTicketCount": { "type": "integer", "description": "Number of transfer ticket operations related to the contract.", "format": "int32" }, "increasePaidStorageCount": { "type": "integer", "description": "Number of `increase_paid_storage` operations related to the contract.", "format": "int32" }, "eventsCount": { "type": "integer", "description": "Number of events produced by the contract.", "format": "int32" }, "firstActivity": { "type": "integer", "description": "Block height of the contract creation. \n**[sortable]**", "format": "int32" }, "firstActivityTime": { "type": "string", "description": "Block datetime of the contract creation (ISO 8601, e.g. `2020-02-20T02:40:57Z`).", "format": "date-time" }, "lastActivity": { "type": "integer", "description": "Height of the block in which the account state was changed last time. \n**[sortable]**", "format": "int32" }, "lastActivityTime": { "type": "string", "description": "Datetime of the block in which the account state was changed last time (ISO 8601, e.g. `2020-02-20T02:40:57Z`).", "format": "date-time" }, "typeHash": { "type": "integer", "description": "32-bit hash of the contract parameter and storage types.\nThis field can be used for searching similar contracts (which have the same interface).", "format": "int32" }, "codeHash": { "type": "integer", "description": "32-bit hash of the contract code.\nThis field can be used for searching same contracts (which have the same script).", "format": "int32" }, "metadata": { "description": "TZIP-16 metadata.", "nullable": true }, "extras": { "description": "Off-chain extras.", "nullable": true }, "storage": { "description": "Contract storage value. Omitted by default. Use `?includeStorage=true` to include it into response.", "nullable": true } } } ] }, "Ghost": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT id", "format": "int32" }, "type": { "type": "string", "description": "Type of the account, `ghost` - contract that has been met among token holders, but hasn't been originated" }, "address": { "type": "string", "description": "Address of the contract" }, "alias": { "type": "string", "description": "Name of the ghost contract", "nullable": true }, "activeTokensCount": { "type": "integer", "description": "Number of account tokens with non-zero balances", "format": "int32" }, "tokenBalancesCount": { "type": "integer", "description": "Number of tokens the account ever had", "format": "int32" }, "tokenTransfersCount": { "type": "integer", "description": "Number of token transfers from/to the account", "format": "int32" }, "activeTicketsCount": { "type": "integer", "description": "Number of tickets the account owns.", "format": "int32" }, "ticketBalancesCount": { "type": "integer", "description": "Number of tickets the account ever owned.", "format": "int32" }, "ticketTransfersCount": { "type": "integer", "description": "Number of ticket transfers from/to the account.", "format": "int32" }, "firstActivity": { "type": "integer", "description": "Block height at which the ghost contract appeared first time", "format": "int32" }, "firstActivityTime": { "type": "string", "description": "Block datetime at which the ghost contract appeared first time (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "lastActivity": { "type": "integer", "description": "Height of the block in which the ghost contract state was changed last time", "format": "int32" }, "lastActivityTime": { "type": "string", "description": "Datetime of the block in which the ghost contract state was changed last time (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "extras": { "description": "Off-chain extras", "nullable": true } } } ] }, "Rollup": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT id", "format": "int32" }, "type": { "type": "string", "description": "Type of the account" }, "address": { "type": "string", "description": "Address of the account" }, "alias": { "type": "string", "description": "Name of the account", "nullable": true }, "creator": { "description": "Information about the account, which has deployed the rollup to the blockchain", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "rollupBonds": { "type": "integer", "description": "Amount of mutez locked as bonds", "format": "int64" }, "activeTokensCount": { "type": "integer", "description": "Number of account tokens with non-zero balances", "format": "int32" }, "tokenBalancesCount": { "type": "integer", "description": "Number of tokens the account ever had", "format": "int32" }, "tokenTransfersCount": { "type": "integer", "description": "Number of token transfers from/to the account", "format": "int32" }, "activeTicketsCount": { "type": "integer", "description": "Number of tickets the account owns.", "format": "int32" }, "ticketBalancesCount": { "type": "integer", "description": "Number of tickets the account ever owned.", "format": "int32" }, "ticketTransfersCount": { "type": "integer", "description": "Number of ticket transfers from/to the account.", "format": "int32" }, "numTransactions": { "type": "integer", "description": "Number of transaction operations related to the account", "format": "int32" }, "txRollupOriginationCount": { "type": "integer", "description": "Number of tx rollup origination operations related to the account", "format": "int32" }, "txRollupSubmitBatchCount": { "type": "integer", "description": "Number of tx rollup submit batch operations related to the account", "format": "int32" }, "txRollupCommitCount": { "type": "integer", "description": "Number of tx rollup commit operations related to the account", "format": "int32" }, "txRollupReturnBondCount": { "type": "integer", "description": "Number of tx rollup return bond operations related to the account", "format": "int32" }, "txRollupFinalizeCommitmentCount": { "type": "integer", "description": "Number of tx rollup finalize commitment operations related to the account", "format": "int32" }, "txRollupRemoveCommitmentCount": { "type": "integer", "description": "Number of tx rollup remove commitment operations related to the account", "format": "int32" }, "txRollupRejectionCount": { "type": "integer", "description": "Number of tx rollup rejection operations related to the account", "format": "int32" }, "txRollupDispatchTicketsCount": { "type": "integer", "description": "Number of tx rollup dispatch tickets operations related to the account", "format": "int32" }, "transferTicketCount": { "type": "integer", "description": "Number of transfer ticket operations related to the account", "format": "int32" }, "firstActivity": { "type": "integer", "description": "Block height at which the ghost contract appeared first time", "format": "int32" }, "firstActivityTime": { "type": "string", "description": "Block datetime at which the ghost contract appeared first time (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "lastActivity": { "type": "integer", "description": "Height of the block in which the ghost contract state was changed last time", "format": "int32" }, "lastActivityTime": { "type": "string", "description": "Datetime of the block in which the ghost contract state was changed last time (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "extras": { "description": "Off-chain extras", "nullable": true } } } ] }, "SmartRollup": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT id", "format": "int32" }, "type": { "type": "string", "description": "Type of the account" }, "address": { "type": "string", "description": "Address of the account" }, "alias": { "type": "string", "description": "Name of the account", "nullable": true }, "creator": { "description": "Information about the account, which has deployed the rollup to the blockchain", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "pvmKind": { "type": "string", "description": "PVM kind: `arith` or `wasm`" }, "genesisCommitment": { "type": "string", "description": "Genesis commitment hash" }, "lastCommitment": { "type": "string", "description": "The most recent cemented commitment hash" }, "inboxLevel": { "type": "integer", "description": "Inbox level of the most recent cemented commitment", "format": "int32" }, "totalStakers": { "type": "integer", "description": "Total number of stakers.", "format": "int32" }, "activeStakers": { "type": "integer", "description": "Total number of active stakers.", "format": "int32" }, "executedCommitments": { "type": "integer", "description": "Number of commitments that were cemented and executed", "format": "int32" }, "cementedCommitments": { "type": "integer", "description": "Number of commitments that were cemented (including executed ones)", "format": "int32" }, "pendingCommitments": { "type": "integer", "description": "Number of pending commitments", "format": "int32" }, "refutedCommitments": { "type": "integer", "description": "Number of commitments that were refuted", "format": "int32" }, "orphanCommitments": { "type": "integer", "description": "Number of commitments that became orphan, due to their parent was refuted", "format": "int32" }, "smartRollupBonds": { "type": "integer", "description": "Amount of mutez locked as bonds", "format": "int64" }, "activeTokensCount": { "type": "integer", "description": "Number of account tokens with non-zero balances", "format": "int32" }, "tokenBalancesCount": { "type": "integer", "description": "Number of tokens the account ever had", "format": "int32" }, "tokenTransfersCount": { "type": "integer", "description": "Number of token transfers from/to the account", "format": "int32" }, "activeTicketsCount": { "type": "integer", "description": "Number of tickets the account owns.", "format": "int32" }, "ticketBalancesCount": { "type": "integer", "description": "Number of tickets the account ever owned.", "format": "int32" }, "ticketTransfersCount": { "type": "integer", "description": "Number of ticket transfers from/to the account.", "format": "int32" }, "numTransactions": { "type": "integer", "description": "Number of transaction operations related to the account", "format": "int32" }, "transferTicketCount": { "type": "integer", "description": "Number of transfer ticket operations related to the account", "format": "int32" }, "smartRollupCementCount": { "type": "integer", "description": "Number of `smart_rollup_cement` operations related to the account", "format": "int32" }, "smartRollupExecuteCount": { "type": "integer", "description": "Number of `smart_rollup_execute_outbox_message` operations related to the account", "format": "int32" }, "smartRollupOriginateCount": { "type": "integer", "description": "Number of `smart_rollup_originate` operations related to the account", "format": "int32" }, "smartRollupPublishCount": { "type": "integer", "description": "Number of `smart_rollup_publish` operations related to the account", "format": "int32" }, "smartRollupRecoverBondCount": { "type": "integer", "description": "Number of `smart_rollup_recover_bond` operations related to the account", "format": "int32" }, "smartRollupRefuteCount": { "type": "integer", "description": "Number of `smart_rollup_refute` operations related to the account", "format": "int32" }, "refutationGamesCount": { "type": "integer", "description": "Number of smart rollup refutation games related to the account", "format": "int32" }, "activeRefutationGamesCount": { "type": "integer", "description": "Number of active smart rollup refutation games related to the account", "format": "int32" }, "firstActivity": { "type": "integer", "description": "Block height at which the ghost contract appeared first time", "format": "int32" }, "firstActivityTime": { "type": "string", "description": "Block datetime at which the ghost contract appeared first time (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "lastActivity": { "type": "integer", "description": "Height of the block in which the ghost contract state was changed last time", "format": "int32" }, "lastActivityTime": { "type": "string", "description": "Datetime of the block in which the ghost contract state was changed last time (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "extras": { "description": "Off-chain extras", "nullable": true } } } ] }, "EmptyAccount": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the account, `empty` - account hasn't appeared in the blockchain yet" }, "address": { "type": "string", "description": "Public key hash of the account" }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" } } } ] }, "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`). \\\nSpecify an integer number to get items where the specified field is equal to the specified value.\n\nExample: `?balance=1234`.", "format": "int32", "nullable": true }, "ne": { "type": "integer", "description": "**Not equal** filter mode. \\\nSpecify an integer number to get items where the specified field is not equal to the specified value.\n\nExample: `?balance.ne=1234`.", "format": "int32", "nullable": true }, "gt": { "type": "integer", "description": "**Greater than** filter mode. \\\nSpecify an integer number to get items where the specified field is greater than the specified value.\n\nExample: `?balance.gt=1234`.", "format": "int32", "nullable": true }, "ge": { "type": "integer", "description": "**Greater or equal** filter mode. \\\nSpecify an integer number to get items where the specified field is greater than equal to the specified value.\n\nExample: `?balance.ge=1234`.", "format": "int32", "nullable": true }, "lt": { "type": "integer", "description": "**Less than** filter mode. \\\nSpecify an integer number to get items where the specified field is less than the specified value.\n\nExample: `?balance.lt=1234`.", "format": "int32", "nullable": true }, "le": { "type": "integer", "description": "**Less or equal** filter mode. \\\nSpecify an integer number to get items where the specified field is less than or equal to the specified value.\n\nExample: `?balance.le=1234`.", "format": "int32", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of integers to get items where the specified field is equal to one of the specified values.\n\nExample: `?level.in=12,14,52,69`.", "nullable": true, "items": { "type": "integer", "format": "int32" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of integers to get items where the specified field is not equal to all the specified values.\n\nExample: `?level.ni=12,14,52,69`.", "nullable": true, "items": { "type": "integer", "format": "int32" } } }, "x-tzkt-extension": "query-parameter" }, "AddressParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=` is the same as `param=`). \\\nSpecify an account address to get items where the specified field is equal to the specified value.\n\nExample: `?address=tz123..`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify an account address to get items where the specified field is not equal to the specified value.\n\nExample: `?address.ne=tz123..`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of account addresses to get items where the specified field is equal to one of the specified values.\n\nExample: `?address.in=tz123..,tz345..`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of account addresses to get items where the specified field is not equal to all the specified values.\n\nExample: `?address.ni=tz123..,tz345..`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter" }, "AccountTypeParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify an account type to get items where the specified field is equal to the specified value.\n\nExample: `?type=delegate`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify an account type to get items where the specified field is not equal to the specified value.\n\nExample: `?type.ne=contract`.", "nullable": true } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "user,contract,delegate" }, "ContractKindParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify a contract kind to get items where the specified field is equal to the specified value.\n\nExample: `?kind=smart_contract`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify a contract kind to get items where the specified field is not equal to the specified value.\n\nExample: `?kind.ne=delegator_contract`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of contract kinds to get items where the specified field is equal to one of the specified values.\n\nExample: `?kind.in=smart_contract,asset`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of contract kinds to get items where the specified field is not equal to all the specified values.\n\nExample: `?kind.ni=smart_contract,asset`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "delegator_contract,smart_contract" }, "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`). \\\nSpecify a `tz` or `KT` address to get items where the specified field is equal to the specified value.\n\nExample: `?sender=tz1WnfXMPaNTBmH7DBPwqCWs9cPDJdkGBTZ8`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify a `tz` or `KT` address to get items where the specified field is not equal to the specified value.\n\nExample: `?sender.ne=tz1WnfXMPaNTBmH7DBPwqCWs9cPDJdkGBTZ8`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of addresses to get items where the specified field is equal to one of the specified values.\n\nExample: `?sender.in=tz1WnfXMPaNTBWnfXMPaNTBWnfXMPaNTBNTB,tz1SiPXX4MYGNJNDSiPXX4MYGNJNDSiPXX4M`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of addresses to get items where the specified field is not equal to all the specified values.\n\nExample: `?sender.ni=tz1WnfXMPaNTBWnfXMPaNTBWnfXMPaNTBNTB,tz1SiPXX4MYGNJNDSiPXX4MYGNJNDSiPXX4M`.", "nullable": true, "items": { "type": "string" } }, "eqx": { "type": "string", "description": "**Equal to another field** filter mode. \\\nSpecify a field name to get items where the specified fields are equal.\n\nExample: `?sender.eqx=target`.", "nullable": true }, "nex": { "type": "string", "description": "**Not equal to another field** filter mode. \\\nSpecify a field name to get items where the specified fields are not equal.\n\nExample: `?sender.nex=initiator`.", "nullable": true }, "null": { "type": "boolean", "description": "**Is null** filter mode. \\\nUse this mode to get items where the specified field is null or not.\n\nExample: `?initiator.null` or `?initiator.null=false`.", "nullable": true }, "inHasNull": { "type": "boolean" }, "niHasNull": { "type": "boolean" } }, "x-tzkt-extension": "query-parameter" }, "BigIntegerNullableParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify an integer number to get items where the specified field is equal to the specified value.\n\nExample: `?balance=1234`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify an integer number to get items where the specified field is not equal to the specified value.\n\nExample: `?balance.ne=1234`.", "nullable": true }, "gt": { "type": "string", "description": "**Greater than** filter mode. \\\nSpecify an integer number to get items where the specified field is greater than the specified value.\n\nExample: `?balance.gt=1234`.", "nullable": true }, "ge": { "type": "string", "description": "**Greater or equal** filter mode. \\\nSpecify an integer number to get items where the specified field is greater than equal to the specified value.\n\nExample: `?balance.ge=1234`.", "nullable": true }, "lt": { "type": "string", "description": "**Less than** filter mode. \\\nSpecify an integer number to get items where the specified field is less than the specified value.\n\nExample: `?balance.lt=1234`.", "nullable": true }, "le": { "type": "string", "description": "**Less or equal** filter mode. \\\nSpecify an integer number to get items where the specified field is less than or equal to the specified value.\n\nExample: `?balance.le=1234`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of integers to get items where the specified field is equal to one of the specified values.\n\nExample: `?level.in=12,14,52,69`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of integers to get items where the specified field is not equal to all the specified values.\n\nExample: `?level.ni=12,14,52,69`.", "nullable": true, "items": { "type": "string" } }, "null": { "type": "boolean", "description": "**Is null** filter mode. \\\nUse this mode to get items where the specified field is null or not.\n\nExample: `?nonce.null` or `?nonce.null=false`.", "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`). \\\nSpecify an integer number to get items where the specified field is equal to the specified value.\n\nExample: `?balance=1234`.", "format": "int64", "nullable": true }, "ne": { "type": "integer", "description": "**Not equal** filter mode. \\\nSpecify an integer number to get items where the specified field is not equal to the specified value.\n\nExample: `?balance.ne=1234`.", "format": "int64", "nullable": true }, "gt": { "type": "integer", "description": "**Greater than** filter mode. \\\nSpecify an integer number to get items where the specified field is greater than the specified value.\n\nExample: `?balance.gt=1234`.", "format": "int64", "nullable": true }, "ge": { "type": "integer", "description": "**Greater or equal** filter mode. \\\nSpecify an integer number to get items where the specified field is greater than equal to the specified value.\n\nExample: `?balance.ge=1234`.", "format": "int64", "nullable": true }, "lt": { "type": "integer", "description": "**Less than** filter mode. \\\nSpecify an integer number to get items where the specified field is less than the specified value.\n\nExample: `?balance.lt=1234`.", "format": "int64", "nullable": true }, "le": { "type": "integer", "description": "**Less or equal** filter mode. \\\nSpecify an integer number to get items where the specified field is less than or equal to the specified value.\n\nExample: `?balance.le=1234`.", "format": "int64", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of integers to get items where the specified field is equal to one of the specified values.\n\nExample: `?level.in=12,14,52,69`.", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of integers to get items where the specified field is not equal to all the specified values.\n\nExample: `?level.ni=12,14,52,69`.", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "empty": { "type": "boolean" } }, "x-tzkt-extension": "query-parameter" }, "BoolParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "boolean", "description": "**Equal** filter mode (optional, i.e. `param.eq=true` is the same as `param=true`). \\\nSpecify a bool flag to get items where the specified field is equal to the specified value.\n\nExample: `?active=true` or `?active=1` or `?active`.", "nullable": true }, "null": { "type": "boolean", "description": "**Is null** filter mode. \\\nUse this mode to get items where the specified field is null or not.\n\nExample: `?active.null` or `?active.null=false`.", "nullable": true } }, "x-tzkt-extension": "query-parameter" }, "SelectParameter": { "type": "object", "additionalProperties": false, "properties": { "fields": { "type": "array", "description": "**Fields** selection mode (optional, i.e. `select.fields=balance` is the same as `select=balance`). \\\nSpecify a comma-separated list of fields to include into response.\n\nExample: `?select=address,balance` => `[ { \"address\": \"asd\", \"balance\": 10 } ]`.", "nullable": true, "items": { "type": "string" } }, "values": { "type": "array", "description": "**Values** selection mode. \\\nSpecify a comma-separated list of fields to include their values into response.\n\nExample: `?select.values=address,balance` => `[ [ \"asd\", 10 ] ]`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter" }, "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`). \\\nSpecify a field name to sort by.\n\nExample: `?sort=balance`.", "nullable": true }, "desc": { "type": "string", "description": "**Descending** sort mode. \\\nSpecify a field name to sort by descending.\n\nExample: `?sort.desc=id`.", "nullable": true } }, "x-tzkt-extension": "query-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`). \\\nSkips specified number of elements.\n\nExample: `?offset=100`.", "format": "int32", "nullable": true }, "pg": { "type": "integer", "description": "**Page** offset mode. \\\nSkips `page * limit` elements. This is a classic pagination.\n\nExample: `?offset.pg=1`.", "format": "int32", "nullable": true }, "cr": { "type": "integer", "description": "**Cursor** offset mode. \\\nSkips all elements with the `cursor` before (including) the specified value. Cursor is a field used for sorting, e.g. `id`.\nAvoid using this offset mode with non-unique or non-sequential cursors such as `amount`, `balance`, etc.\n\nExample: `?offset.cr=45837`.", "format": "int64", "nullable": true } }, "x-tzkt-extension": "query-parameter" }, "Activity": { "type": "object", "discriminator": { "propertyName": "type", "mapping": { "ticket_transfer": "#/components/schemas/TicketTransferActivity", "token_transfer": "#/components/schemas/TokenTransferActivity", "autostaking": "#/components/schemas/AutostakingOperation", "baking": "#/components/schemas/BakingOperation", "ballot": "#/components/schemas/BallotOperation", "dal_attestation_reward": "#/components/schemas/DalAttestationRewardOperation", "dal_entrapment_evidence": "#/components/schemas/DalEntrapmentEvidenceOperation", "dal_publish_commitment": "#/components/schemas/DalPublishCommitmentOperation", "delegation": "#/components/schemas/DelegationOperation", "double_baking": "#/components/schemas/DoubleBakingOperation", "double_consensus": "#/components/schemas/DoubleConsensusOperation", "drain_delegate": "#/components/schemas/DrainDelegateOperation", "attestation": "#/components/schemas/AttestationOperation", "attestation_reward": "#/components/schemas/AttestationRewardOperation", "increase_paid_storage": "#/components/schemas/IncreasePaidStorageOperation", "migration": "#/components/schemas/MigrationOperation", "nonce_revelation": "#/components/schemas/NonceRevelationOperation", "origination": "#/components/schemas/OriginationOperation", "preattestation": "#/components/schemas/PreattestationOperation", "proposal": "#/components/schemas/ProposalOperation", "register_constant": "#/components/schemas/RegisterConstantOperation", "reveal": "#/components/schemas/RevealOperation", "revelation_penalty": "#/components/schemas/RevelationPenaltyOperation", "set_delegate_parameters": "#/components/schemas/SetDelegateParametersOperation", "set_deposits_limit": "#/components/schemas/SetDepositsLimitOperation", "sr_add_messages": "#/components/schemas/SmartRollupAddMessagesOperation", "sr_cement": "#/components/schemas/SmartRollupCementOperation", "sr_execute": "#/components/schemas/SmartRollupExecuteOperation", "sr_originate": "#/components/schemas/SmartRollupOriginateOperation", "sr_publish": "#/components/schemas/SmartRollupPublishOperation", "sr_recover_bond": "#/components/schemas/SmartRollupRecoverBondOperation", "sr_refute": "#/components/schemas/SmartRollupRefuteOperation", "staking": "#/components/schemas/StakingOperation", "transaction": "#/components/schemas/TransactionOperation", "transfer_ticket": "#/components/schemas/TransferTicketOperation", "tx_rollup_commit": "#/components/schemas/TxRollupCommitOperation", "tx_rollup_dispatch_tickets": "#/components/schemas/TxRollupDispatchTicketsOperation", "tx_rollup_finalize_commitment": "#/components/schemas/TxRollupFinalizeCommitmentOperation", "tx_rollup_origination": "#/components/schemas/TxRollupOriginationOperation", "tx_rollup_rejection": "#/components/schemas/TxRollupRejectionOperation", "tx_rollup_remove_commitment": "#/components/schemas/TxRollupRemoveCommitmentOperation", "tx_rollup_return_bond": "#/components/schemas/TxRollupReturnBondOperation", "tx_rollup_submit_batch": "#/components/schemas/TxRollupSubmitBatchOperation", "update_secondary_key": "#/components/schemas/UpdateSecondaryKeyOperation", "vdf_revelation": "#/components/schemas/VdfRevelationOperation", "activation": "#/components/schemas/ActivationOperation" } }, "x-abstract": true, "additionalProperties": false, "required": [ "type" ], "properties": { "type": { "type": "string", "description": "Type of the activity element" }, "id": { "type": "integer", "description": "Internal ID of the activity element", "format": "int64" } } }, "ActivationOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `activation` - is used to activate accounts that were recommended allocations of\ntezos tokens for donations to the Tezos Foundation’s fundraiser." }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block, from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "account": { "description": "Information about activated account", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "balance": { "type": "integer", "description": "Account activation balance of tezos tokens that were recommended allocations for donations to the Tezos Foundation’s fundraiser", "format": "int64" }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "QuoteShort": { "type": "object", "additionalProperties": false, "properties": { "btc": { "type": "number", "description": "XTZ/BTC price", "format": "double", "nullable": true }, "eur": { "type": "number", "description": "XTZ/EUR price", "format": "double", "nullable": true }, "usd": { "type": "number", "description": "XTZ/USD price", "format": "double", "nullable": true }, "cny": { "type": "number", "description": "XTZ/CNY price", "format": "double", "nullable": true }, "jpy": { "type": "number", "description": "XTZ/JPY price", "format": "double", "nullable": true }, "krw": { "type": "number", "description": "XTZ/KRW price", "format": "double", "nullable": true }, "eth": { "type": "number", "description": "XTZ/ETH price", "format": "double", "nullable": true }, "gbp": { "type": "number", "description": "XTZ/GBP price", "format": "double", "nullable": true } } }, "Operation": { "allOf": [ { "type": "object", "discriminator": { "propertyName": "type", "mapping": { "autostaking": "#/components/schemas/AutostakingOperation", "baking": "#/components/schemas/BakingOperation", "ballot": "#/components/schemas/BallotOperation", "dal_attestation_reward": "#/components/schemas/DalAttestationRewardOperation", "dal_entrapment_evidence": "#/components/schemas/DalEntrapmentEvidenceOperation", "dal_publish_commitment": "#/components/schemas/DalPublishCommitmentOperation", "delegation": "#/components/schemas/DelegationOperation", "double_baking": "#/components/schemas/DoubleBakingOperation", "double_consensus": "#/components/schemas/DoubleConsensusOperation", "drain_delegate": "#/components/schemas/DrainDelegateOperation", "attestation": "#/components/schemas/AttestationOperation", "attestation_reward": "#/components/schemas/AttestationRewardOperation", "increase_paid_storage": "#/components/schemas/IncreasePaidStorageOperation", "migration": "#/components/schemas/MigrationOperation", "nonce_revelation": "#/components/schemas/NonceRevelationOperation", "origination": "#/components/schemas/OriginationOperation", "preattestation": "#/components/schemas/PreattestationOperation", "proposal": "#/components/schemas/ProposalOperation", "register_constant": "#/components/schemas/RegisterConstantOperation", "reveal": "#/components/schemas/RevealOperation", "revelation_penalty": "#/components/schemas/RevelationPenaltyOperation", "set_delegate_parameters": "#/components/schemas/SetDelegateParametersOperation", "set_deposits_limit": "#/components/schemas/SetDepositsLimitOperation", "sr_add_messages": "#/components/schemas/SmartRollupAddMessagesOperation", "sr_cement": "#/components/schemas/SmartRollupCementOperation", "sr_execute": "#/components/schemas/SmartRollupExecuteOperation", "sr_originate": "#/components/schemas/SmartRollupOriginateOperation", "sr_publish": "#/components/schemas/SmartRollupPublishOperation", "sr_recover_bond": "#/components/schemas/SmartRollupRecoverBondOperation", "sr_refute": "#/components/schemas/SmartRollupRefuteOperation", "staking": "#/components/schemas/StakingOperation", "transaction": "#/components/schemas/TransactionOperation", "transfer_ticket": "#/components/schemas/TransferTicketOperation", "tx_rollup_commit": "#/components/schemas/TxRollupCommitOperation", "tx_rollup_dispatch_tickets": "#/components/schemas/TxRollupDispatchTicketsOperation", "tx_rollup_finalize_commitment": "#/components/schemas/TxRollupFinalizeCommitmentOperation", "tx_rollup_origination": "#/components/schemas/TxRollupOriginationOperation", "tx_rollup_rejection": "#/components/schemas/TxRollupRejectionOperation", "tx_rollup_remove_commitment": "#/components/schemas/TxRollupRemoveCommitmentOperation", "tx_rollup_return_bond": "#/components/schemas/TxRollupReturnBondOperation", "tx_rollup_submit_batch": "#/components/schemas/TxRollupSubmitBatchOperation", "update_secondary_key": "#/components/schemas/UpdateSecondaryKeyOperation", "vdf_revelation": "#/components/schemas/VdfRevelationOperation", "activation": "#/components/schemas/ActivationOperation" } }, "x-abstract": true, "additionalProperties": false, "required": [ "type" ], "properties": { "type": { "type": "string", "description": "Type of the operation" }, "id": { "type": "integer", "description": "Internal ID of the operation", "format": "int64" } } } ] }, "AutostakingOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `autostaking`" }, "id": { "type": "integer", "description": "Internal TzKT ID. \n**[sortable]**", "format": "int64" }, "level": { "type": "integer", "description": "Height of the block from the genesis", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime at which the block is claimed to have been created (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "baker": { "description": "Baker for which autostaking event happened", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "action": { "type": "string", "description": "Autostaking action (`stake`, `unstake`, `finalize`)" }, "amount": { "type": "integer", "description": "Amount (micro tez)", "format": "int64" }, "stakingUpdatesCount": { "type": "integer", "description": "Number of staking updates happened internally", "format": "int64" }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "BakingOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `baking` - an operation which contains brief information about a baked (produced) block (synthetic type)" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "Height of the block from the genesis", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime at which the block is claimed to have been created (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Block hash" }, "proposer": { "description": "Baker who proposed the block payload", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "producer": { "description": "Baker who produced the block", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "payloadRound": { "type": "integer", "description": "Round at which the block payload was proposed", "format": "int32" }, "blockRound": { "type": "integer", "description": "Round at which the block was produced", "format": "int32" }, "deposit": { "type": "integer", "description": "Security deposit frozen on the baker's account for producing the block (micro tez)", "format": "int64" }, "rewardDelegated": { "type": "integer", "description": "Portion of fixed reward, corresponding to delegated stake, paid to payload proposer's liquid balance (micro tez)\n(it is not frozen and can be spent immediately).", "format": "int64" }, "rewardStakedOwn": { "type": "integer", "description": "Portion of fixed reward, corresponding to baker's own stake, paid to payload proposer's own staked balance (micro tez)\n(it is frozen and belongs to the baker).", "format": "int64" }, "rewardStakedEdge": { "type": "integer", "description": "Portion of fixed reward, corresponding to baker's edge from external stake, paid to payload proposer's own staked balance (micro tez)\n(it is frozen and belongs to the baker).", "format": "int64" }, "rewardStakedShared": { "type": "integer", "description": "Portion of fixed reward, corresponding to baker's external stake, paid to payload proposer's external staked balance (micro tez)\n(it is frozen and belongs to baker's stakers).", "format": "int64" }, "bonusDelegated": { "type": "integer", "description": "Portion of bonus reward, corresponding to delegated stake, paid to block producer's liquid balance (micro tez)\n(it is not frozen and can be spent immediately).", "format": "int64" }, "bonusStakedOwn": { "type": "integer", "description": "Portion of bonus reward, corresponding to baker's own stake, paid to block producer's own staked balance (micro tez)\n(it is frozen and belongs to the baker).", "format": "int64" }, "bonusStakedEdge": { "type": "integer", "description": "Portion of bonus reward, corresponding to baker's edge from external stake, paid to block producer's own staked balance (micro tez)\n(it is frozen and belongs to the baker).", "format": "int64" }, "bonusStakedShared": { "type": "integer", "description": "Portion of fixed reward, corresponding to baker's external stake, paid to block producer's external staked balance (micro tez)\n(it is frozen and belongs to baker's stakers).", "format": "int64" }, "fees": { "type": "integer", "description": "Total fee gathered from operations, included into the block", "format": "int64" }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "BallotOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `ballot` - is used to vote for a proposal in a given voting cycle" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "period": { "description": "Information about the voting period for which the ballot was submitted", "oneOf": [ { "$ref": "#/components/schemas/PeriodInfo" } ] }, "proposal": { "description": "Information about the proposal for which ballot was submitted", "oneOf": [ { "$ref": "#/components/schemas/ProposalAlias" } ] }, "delegate": { "description": "Information about the delegate (baker), submitted the ballot", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "votingPower": { "type": "integer", "description": "Baker's voting power", "format": "int64" }, "vote": { "type": "string", "description": "Vote, given in the ballot (`yay`, `nay`, or `pass`)" }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "PeriodInfo": { "type": "object", "additionalProperties": false, "properties": { "index": { "type": "integer", "description": "Voting period index, starting from zero", "format": "int32" }, "epoch": { "type": "integer", "description": "Voting epoch index, starting from zero", "format": "int32" }, "kind": { "type": "string", "description": "Kind of the voting period\n`proposal` - delegates can submit protocol amendment proposals using the proposal operation\n`exploration` - bakers (delegates) may vote on the top-ranked proposal from the previous Proposal Period using the ballot operation\n`testing` - If the proposal is approved in the Exploration Period, the testing (or 'cooldown') period begins and bakers start testing the new protocol\n`promotion` - delegates can cast one vote to promote or not the tested proposal using the ballot operation\n`adoption` - after the proposal is actually accepted, the ecosystem has some time to prepare to the upgrade" }, "firstLevel": { "type": "integer", "description": "The height of the block in which the period starts", "format": "int32" }, "lastLevel": { "type": "integer", "description": "The height of the block in which the period ends", "format": "int32" } } }, "ProposalAlias": { "type": "object", "additionalProperties": false, "properties": { "alias": { "type": "string", "description": "Alias of the proposal", "nullable": true }, "hash": { "type": "string", "description": "Hash of the proposal, which representing a tarball of concatenated .ml/.mli source files" } } }, "DalAttestationRewardOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `dal_attestation_reward`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "Height of the block from the genesis", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime at which the block is claimed to have been created (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Block hash" }, "baker": { "description": "Baker expected to receive dal attestation reward", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "expected": { "type": "integer", "description": "Expected dal attestation reward, based on baker's active stake (micro tez)", "format": "int64" }, "rewardDelegated": { "type": "integer", "description": "Reward, corresponding to delegated stake, paid to baker's liquid balance (micro tez)\n(it is not frozen and can be spent immediately).", "format": "int64" }, "rewardStakedOwn": { "type": "integer", "description": "Reward, corresponding to baker's own stake, paid to baker's own staked balance (micro tez)\n(it is frozen and belongs to the baker).", "format": "int64" }, "rewardStakedEdge": { "type": "integer", "description": "Reward, corresponding to baker's edge from external stake, paid to baker's own staked balance (micro tez)\n(it is frozen and belongs to the baker).", "format": "int64" }, "rewardStakedShared": { "type": "integer", "description": "Reward, corresponding to baker's external stake, paid to baker's external staked balance (micro tez)\n(it is frozen and belongs to baker's stakers).", "format": "int64" }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "DalEntrapmentEvidenceOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `dal_entrapment_evidence`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "accuser": { "description": "Information about the baker, produced the block, in which the evidence was included", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "offender": { "description": "Information about the baker, accused for attesting trapped shard", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "trapLevel": { "type": "integer", "description": "Height of the block from the genesis, where the trap was attested", "format": "int32" }, "trapSlotIndex": { "type": "integer", "description": "Trap slot index", "format": "int32" }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "DalPublishCommitmentOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `dal_publish_commitment`" }, "id": { "type": "integer", "description": "Internal TzKT ID. \n**[sortable]**", "format": "int64" }, "level": { "type": "integer", "description": "Height of the block from the genesis", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime at which the block is claimed to have been created (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "slot": { "type": "integer", "description": "Slot number", "format": "int32" }, "commitment": { "type": "string", "description": "Commitment hash" }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "OperationError": { "type": "object", "discriminator": { "propertyName": "type", "mapping": { "error.id": "#/components/schemas/BaseOperationError", "contract.balance_too_low": "#/components/schemas/BalanceTooLowError", "contract.non_existing_contract": "#/components/schemas/NonExistingContractError", "contract.manager.unregistered_delegate": "#/components/schemas/UnregisteredDelegateError", "Expression_already_registered": "#/components/schemas/ExpressionAlreadyRegisteredError" } }, "x-abstract": true, "additionalProperties": false, "required": [ "type" ], "properties": { "type": { "type": "string", "description": "Type of an error (`error.id`, `contract.balance_too_low`, `contract.non_existing_contract`,\n`contract.manager.unregistered_delegate`, etc.)\nhttps://tezos.gitlab.io/api/errors.html - full list of errors" } } }, "BaseOperationError": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of an error\nhttps://tezos.gitlab.io/api/errors.html - full list of errors" } } } ] }, "BalanceTooLowError": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of an error, `contract.balance_too_low` - an operation tried to spend more then the contract has\nhttps://tezos.gitlab.io/api/errors.html - full list of errors" }, "balance": { "type": "integer", "description": "Balance of the contract", "format": "int64" }, "required": { "type": "integer", "description": "Required balance to send the operation", "format": "int64" } } } ] }, "NonExistingContractError": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of an error, `contract.non_existing_contract` - the operation was sent to non-existent contract\nhttps://tezos.gitlab.io/api/errors.html - full list of errors" }, "contract": { "type": "string", "description": "Public key hash of the account to which in the operation tried to send to" } } } ] }, "UnregisteredDelegateError": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of an error, `contract.manager.unregistered_delegate` - an operation of delegation was sent to an account,\nnot registered as a delegate (baker)\nhttps://tezos.gitlab.io/api/errors.html - full list of errors" }, "delegate": { "type": "string", "description": "Public key hash of the account to which in the operation tried to delegate to" } } } ] }, "ExpressionAlreadyRegisteredError": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of an error, `Expression_already_registered` - an operation tried to register\nan already existing global constant\nhttps://tezos.gitlab.io/api/errors.html - full list of errors" }, "expression": { "type": "string", "description": "Global address of the constant" } } } ] }, "DelegationOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `delegation` - is used to delegate funds to a delegate (an implicit account registered as a baker)" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "initiator": { "description": "Information about the initiator of the delegation contract call", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "sender": { "description": "Information about the delegated account", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "senderCodeHash": { "type": "integer", "description": "Hash of the sender contract code, or `null` is the sender is not a contract", "format": "int32", "nullable": true }, "nonce": { "type": "integer", "description": "An account nonce which is used to prevent internal operation replay", "format": "int32", "nullable": true }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to a baker, produced block, in which the operation was included", "format": "int64" }, "amount": { "type": "integer", "description": "Sender's balance at the time of delegation operation (aka delegation amount).", "format": "int64" }, "stakingUpdatesCount": { "type": "integer", "description": "Number of staking updates happened internally", "format": "int32", "nullable": true }, "prevDelegate": { "description": "Information about the previous delegate of the account. `null` if there is no previous delegate", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "newDelegate": { "description": "Information about the delegate to which the operation was sent. `null` if there is no new delegate (an un-delegation operation)", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "DoubleBakingOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `double_baking` - is used by bakers to provide evidence of double baking\n(baking two different blocks at the same height) by a baker" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "Height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "accusedLevel": { "type": "integer", "description": "Height of the block from the genesis, which was double baked", "format": "int32" }, "slashedLevel": { "type": "integer", "description": "Height of the block from the genesis, at which the offender was slashed", "format": "int32" }, "accuser": { "description": "Information about the baker, produced the block, in which the accusation was included", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "reward": { "type": "integer", "description": "Reward of the baker, produced the block, in which the accusation was included", "format": "int64" }, "offender": { "description": "Information about the baker, accused for producing two different blocks at the same level", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "lostStaked": { "type": "integer", "description": "Amount slashed from baker's own staked balance", "format": "int64" }, "lostUnstaked": { "type": "integer", "description": "Amount slashed from baker's own unstaked balance", "format": "int64" }, "lostExternalStaked": { "type": "integer", "description": "Amount slashed from baker's external staked balance", "format": "int64" }, "lostExternalUnstaked": { "type": "integer", "description": "Amount slashed from baker's external unstaked balance", "format": "int64" }, "stakingUpdatesCount": { "type": "integer", "description": "Number of staking updates happened internally", "format": "int32", "nullable": true }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "DoubleConsensusOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `double_consensus` - is used by bakers to provide evidence of double (pre)attestation\n((pre)attestation of two different blocks at the same block height) by a baker" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "Height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "accusedLevel": { "type": "integer", "description": "Height of the block from the genesis, at which double (pre)attestation occurred ", "format": "int32" }, "slashedLevel": { "type": "integer", "description": "Height of the block from the genesis, at which the offender was slashed", "format": "int32" }, "kind": { "type": "string", "description": "Kind of misbehaviour (`double_attestation` or `double_preattestation`)" }, "accuser": { "description": "Information about the baker, produced the block, in which the accusation was included", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "reward": { "type": "integer", "description": "Reward of the baker, produced the block, in which the accusation was included", "format": "int64" }, "offender": { "description": "Information about the baker, accused for producing two different attestations at the same level", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "lostStaked": { "type": "integer", "description": "Amount slashed from baker's own staked balance", "format": "int64" }, "lostUnstaked": { "type": "integer", "description": "Amount slashed from baker's own unstaked balance", "format": "int64" }, "lostExternalStaked": { "type": "integer", "description": "Amount slashed from baker's external staked balance", "format": "int64" }, "lostExternalUnstaked": { "type": "integer", "description": "Amount slashed from baker's external unstaked balance", "format": "int64" }, "stakingUpdatesCount": { "type": "integer", "description": "Number of staking updates happened internally", "format": "int32", "nullable": true }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "DrainDelegateOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `drain_delegate`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "delegate": { "description": "Information about the drained delegate", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "target": { "description": "Information about the recipient account", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "amount": { "type": "integer", "description": "Amount sent from the drained baker to the target", "format": "int64" }, "fee": { "type": "integer", "description": "Amount sent from the drained baker to the block baker", "format": "int64" }, "allocationFee": { "type": "integer", "description": "The amount of funds burned from the drained baker for account creation (micro tez)", "format": "int64" }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "AttestationOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `attestation` - is operation, which specifies the head of the chain as seen by the attester of a given slot.\nThe attester is randomly selected to be included in the block that extends the head of the chain as specified in this operation.\nA block with more attestations improves the weight of the chain and increases the likelihood of that chain being the canonical one." }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "delegate": { "description": "Information about the baker who sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "power": { "type": "integer", "description": "Attestation power", "format": "int64" }, "deposit": { "type": "integer", "description": "Security deposit frozen on the baker's account", "format": "int64" }, "rewards": { "type": "integer", "description": "Reward of the baker for the operation", "format": "int64" }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] }, "slots": { "type": "integer", "description": "**DEPRECATED**", "format": "int32" } } } ] }, "AttestationRewardOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `attestation_reward`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "Height of the block from the genesis", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime at which the block is claimed to have been created (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Block hash" }, "baker": { "description": "Baker expected to receive attestation reward", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "expected": { "type": "integer", "description": "Expected attestation reward, based on baker's active stake (micro tez)", "format": "int64" }, "rewardDelegated": { "type": "integer", "description": "Reward, corresponding to delegated stake, paid to baker's liquid balance (micro tez)\n(it is not frozen and can be spent immediately).", "format": "int64" }, "rewardStakedOwn": { "type": "integer", "description": "Reward, corresponding to baker's own stake, paid to baker's own staked balance (micro tez)\n(it is frozen and belongs to the baker).", "format": "int64" }, "rewardStakedEdge": { "type": "integer", "description": "Reward, corresponding to baker's edge from external stake, paid to baker's own staked balance (micro tez)\n(it is frozen and belongs to the baker).", "format": "int64" }, "rewardStakedShared": { "type": "integer", "description": "Reward, corresponding to baker's external stake, paid to baker's external staked balance (micro tez)\n(it is frozen and belongs to baker's stakers).", "format": "int64" }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "IncreasePaidStorageOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `increase_paid_storage`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "storageUsed": { "type": "integer", "description": "Amount of storage, consumed by the operation", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "storageFee": { "type": "integer", "description": "The amount of funds burned from the sender account for used the blockchain storage (micro tez)", "format": "int64" }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "contract": { "description": "Information about the contract for which paid storage was increased", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "amount": { "type": "string", "description": "Amount of storage in bytes prepaid." }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "MigrationOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `migration` - result of the context (database) migration during a protocol update (synthetic type)" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "kind": { "type": "string", "description": "Kind of the migration \n`bootstrap` - balance updates, included in the first block after genesis\n`activate_delegate` - registering a new baker (delegator) during protocol migration\n`airdrop` - airdrop of 1 micro tez during Babylon protocol upgrade\n`proposal_invoice` - invoice for creation a proposal for protocol upgrade\n`code_change` - changing contract scripts during Babylon protocol upgrade\n`origination` - implicit (hardcoded in the protocol) origination of liquidity baking contracts\n`subsidy` - liquidity baking subsidy\n`remove_bigmap_key` - removing the key from the bigmap" }, "account": { "description": "Information about the account whose balance has updated as a result of the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "balanceChange": { "type": "integer", "description": "The amount for which the operation updated the balance (micro tez)", "format": "int64" }, "storage": { "description": "Contract storage after the migration converted to human-readable JSON. Note: you can configure storage format by setting `micheline` query parameter.", "nullable": true }, "diffs": { "type": "array", "description": "List of bigmap updates caused by the migration.", "nullable": true, "items": { "$ref": "#/components/schemas/BigMapDiff" } }, "tokenTransfersCount": { "type": "integer", "description": "Number of token transfers produced by the operation, or `null` if there are no transfers", "format": "int32", "nullable": true }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "BigMapDiff": { "type": "object", "additionalProperties": false, "properties": { "bigmap": { "type": "integer", "description": "Bigmap Id", "format": "int32" }, "path": { "type": "string", "description": "Path to the bigmap in the contract storage" }, "action": { "type": "string", "description": "Action with the bigmap (`allocate`, `add_key`, `update_key`, `remove_key`, `remove`)" }, "content": { "description": "Affected key.\nIf the action is `allocate` or `remove` the content will be `null`.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BigMapKeyShort" } ] } } }, "BigMapKeyShort": { "type": "object", "additionalProperties": false, "properties": { "hash": { "type": "string", "description": "Key hash" }, "key": { "description": "Key in JSON or Micheline format, depending on the `micheline` query parameter." }, "value": { "description": "Value in JSON or Micheline format, depending on the `micheline` query parameter.\nNote, if the action is `remove_key` it will contain the last non-null value." } } }, "NonceRevelationOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `nonce_revelation` - are used by the blockchain to create randomness" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "baker": { "description": "Information about the delegate (baker), who produced the block with the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "sender": { "description": "Information about the delegate (baker), who revealed the nonce (sent the operation)", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "revealedLevel": { "type": "integer", "description": "Block height of the block, where seed nonce hash is stored", "format": "int32" }, "revealedCycle": { "type": "integer", "description": "Cycle for which seed nonce was revealed", "format": "int32" }, "nonce": { "type": "string", "description": "Seed nonce hex" }, "rewardDelegated": { "type": "integer", "description": "Reward, corresponding to delegated stake, paid to baker's liquid balance (micro tez)\n(it is not frozen and can be spent immediately).", "format": "int64" }, "rewardStakedOwn": { "type": "integer", "description": "Reward, corresponding to baker's own stake, paid to baker's own staked balance (micro tez)\n(it is frozen and belongs to the baker).", "format": "int64" }, "rewardStakedEdge": { "type": "integer", "description": "Reward, corresponding to baker's edge from external stake, paid to baker's own staked balance (micro tez)\n(it is frozen and belongs to the baker).", "format": "int64" }, "rewardStakedShared": { "type": "integer", "description": "Reward, corresponding to baker's external stake, paid to baker's external staked balance (micro tez)\n(it is frozen and belongs to baker's stakers).", "format": "int64" }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "OriginationOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `origination` - deployment / contract creation operation." }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "initiator": { "description": "Information about the initiator of the contract call", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "sender": { "description": "Information about the account, created a contract", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "senderCodeHash": { "type": "integer", "description": "Hash of the sender contract code, or `null` is the sender is not a contract", "format": "int32", "nullable": true }, "nonce": { "type": "integer", "description": "An account nonce which is used to prevent internal operation replay", "format": "int32", "nullable": true }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "storageUsed": { "type": "integer", "description": "Amount of storage, consumed by the operation", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "storageFee": { "type": "integer", "description": "The amount of funds burned from the sender account for contract storage in the blockchain (micro tez)", "format": "int64" }, "allocationFee": { "type": "integer", "description": "The amount of funds burned from the sender account for contract account creation (micro tez)", "format": "int64" }, "contractBalance": { "type": "integer", "description": "The contract origination balance (micro tez)", "format": "int64" }, "contractDelegate": { "description": "Information about the baker (delegate), which was marked as a delegate in the operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "code": { "description": "Contract code. Note: you can configure code format by setting `micheline` query parameter (`0 | 2` - raw micheline, `1 | 3` - raw micheline string).", "nullable": true }, "storage": { "description": "Initial contract storage value converted to human-readable JSON. Note: you can configure storage format by setting `micheline` query parameter.", "nullable": true }, "diffs": { "type": "array", "description": "List of bigmap updates (aka big_map_diffs) caused by the origination.", "nullable": true, "items": { "$ref": "#/components/schemas/BigMapDiff" } }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was a successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "originatedContract": { "description": "Information about the originated ( deployed / created ) contract", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OriginatedContract" } ] }, "tokenTransfersCount": { "type": "integer", "description": "Number of token transfers produced by the operation, or `null` if there are no transfers", "format": "int32", "nullable": true }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "OriginatedContract": { "type": "object", "additionalProperties": false, "properties": { "kind": { "type": "string", "description": "Kind of the contract (`delegator_contract` or `smart_contract`),\nwhere `delegator_contract` - manager.tz smart contract for delegation purpose only" }, "alias": { "type": "string", "description": "Name of the project behind the contract or contract description", "nullable": true }, "address": { "type": "string", "description": "Public key hash of the contract" }, "typeHash": { "type": "integer", "description": "32-bit hash of the contract parameter and storage types.\nThis field can be used for searching similar contracts (which have the same interface).", "format": "int32" }, "codeHash": { "type": "integer", "description": "32-bit hash of the contract code.\nThis field can be used for searching same contracts (which have the same script).", "format": "int32" }, "tzips": { "type": "array", "description": "List of implemented standards (TZIPs)", "nullable": true, "items": { "type": "string" } } } }, "PreattestationOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `preattestation`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "delegate": { "description": "Information about the baker who sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "power": { "type": "integer", "description": "Attestation power", "format": "int64" }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] }, "slots": { "type": "integer", "description": "**DEPRECATED**", "format": "int32" } } } ] }, "ProposalOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `proposal` - is used by bakers (delegates) to submit and/or upvote proposals to amend the protocol" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "period": { "description": "Information about the proposal period for which the proposal was submitted (upvoted)", "oneOf": [ { "$ref": "#/components/schemas/PeriodInfo" } ] }, "proposal": { "description": "Information about the submitted (upvoted) proposal", "oneOf": [ { "$ref": "#/components/schemas/ProposalAlias" } ] }, "delegate": { "description": "Information about the baker (delegate), submitted (upvoted) the proposal operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "votingPower": { "type": "integer", "description": "Baker's voting power", "format": "int64" }, "duplicated": { "type": "boolean", "description": "Indicates whether proposal upvote has already been pushed. Duplicated proposal operations are not counted when selecting proposal-winner." }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "RegisterConstantOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `register_constant` - is used to register a global\nconstant - Micheline expression that can be reused by multiple smart contracts" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "storageUsed": { "type": "integer", "description": "Amount of storage, consumed by the operation", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "storageFee": { "type": "integer", "description": "The amount of funds burned from the sender account for used the blockchain storage (micro tez)", "format": "int64" }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "address": { "type": "string", "description": "Global address of the registered constant (null if the operation failed)", "nullable": true }, "value": { "description": "Constant value. Note: you can configure code format by setting `micheline` query parameter (`0 | 2` - raw micheline, `1 | 3` - raw micheline string).", "nullable": true }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "RevealOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `reveal` - is used to reveal the public key associated with an account" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "publicKey": { "type": "string", "description": "Revealed public key", "nullable": true }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "RevelationPenaltyOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `revelation_penalty` - is operation, in which rewards were lost due to unrevealed seed nonces by the delegate (synthetic type)" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "baker": { "description": "Information about the delegate (baker) who has lost rewards due to unrevealed seed nonces ", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "missedLevel": { "type": "integer", "description": "Height of the block, which contains hash of the seed nonce, which was to be revealed", "format": "int32" }, "loss": { "type": "integer", "description": "Reward for baking and gathered fees from the block, which were lost due to unrevealed seed nonces (micro tez)", "format": "int64" }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "SetDelegateParametersOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `set_delegate_parameters`" }, "id": { "type": "integer", "description": "Internal TzKT ID. \n**[sortable]**", "format": "int64" }, "level": { "type": "integer", "description": "Height of the block from the genesis", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime at which the block is claimed to have been created (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "limitOfStakingOverBaking": { "type": "integer", "description": "This parameter determines the maximum portion (millionth) of external stake by stakers over the baker's own staked funds", "format": "int64", "nullable": true }, "edgeOfBakingOverStaking": { "type": "integer", "description": "This parameter determines the fraction (billionth) of the rewards that accrue to the delegate’s frozen deposit – the remainder is shared among its stakers", "format": "int64", "nullable": true }, "activationCycle": { "type": "integer", "description": "Cycle from which the specified staking parameters are activated", "format": "int32", "nullable": true }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "SetDepositsLimitOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `set_deposits_limit`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "limit": { "type": "string", "description": "Frozen deposits limit (mutez), or `null` if no limit.", "nullable": true }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "SmartRollupAddMessagesOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `sr_add_messages`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database \n**[sortable]**", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "messagesCount": { "type": "integer", "description": "Number of messages added to the smart rollup inbox", "format": "int32" }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "SmartRollupCementOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `sr_cement`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database \n**[sortable]**", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "rollup": { "description": "Smart rollup to which the operation was sent", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "commitment": { "description": "Cemented commitment", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SrCommitmentInfo" } ] }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "SrCommitmentInfo": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT id.", "format": "int64" }, "initiator": { "description": "Account that published the commitment first.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "inboxLevel": { "type": "integer", "description": "Inbox level", "format": "int32" }, "state": { "type": "string", "description": "State hash" }, "hash": { "type": "string", "description": "Commitment hash" }, "ticks": { "type": "integer", "description": "Number of ticks", "format": "int64" }, "firstLevel": { "type": "integer", "description": "Level of the block where the commitment was first published.", "format": "int32" }, "firstTime": { "type": "string", "description": "Timestamp of the block where the commitment was first published.", "format": "date-time" } } }, "SmartRollupExecuteOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `sr_execute`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database \n**[sortable]**", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "storageUsed": { "type": "integer", "description": "Amount of storage, consumed by the operation", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "storageFee": { "type": "integer", "description": "The amount of funds burned from the sender account for used the blockchain storage (micro tez)", "format": "int64" }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "rollup": { "description": "Smart rollup to which the operation was sent", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "commitment": { "description": "Executed commitment", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SrCommitmentInfo" } ] }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "ticketTransfersCount": { "type": "integer", "description": "Number of ticket transfers produced by the operation, or `null` if there are no transfers", "format": "int32", "nullable": true }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "SmartRollupOriginateOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `sr_originate`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database \n**[sortable]**", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "storageUsed": { "type": "integer", "description": "Amount of storage, consumed by the operation", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "storageFee": { "type": "integer", "description": "The amount of funds burned from the sender account for used the blockchain storage (micro tez)", "format": "int64" }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "pvmKind": { "type": "string", "description": "PVM kind (`arith` or `wasm`)." }, "kernel": { "type": "string", "description": "Kernel bytes (in base64).", "format": "byte" }, "parameterType": { "description": "Smart rollup parameter type. Note: you can configure format by setting `micheline` query parameter.", "nullable": true }, "genesisCommitment": { "type": "string", "description": "Genesis commitment hash.", "nullable": true }, "rollup": { "description": "Originated smart rollup.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "SmartRollupPublishOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `sr_publish`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database \n**[sortable]**", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "rollup": { "description": "Smart rollup to which the operation was sent", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "commitment": { "description": "Published commitment", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SrCommitmentInfo" } ] }, "bond": { "type": "integer", "description": "Amount of bonds locked (micro tez)", "format": "int64" }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "SmartRollupRecoverBondOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `sr_recover_bond`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database \n**[sortable]**", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "rollup": { "description": "Smart rollup to which the operation was sent", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "staker": { "description": "Staker account, which's bond should be returned", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "bond": { "type": "integer", "description": "Amount of bonds returned (micro tez)", "format": "int64" }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "SmartRollupRefuteOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `sr_refute`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database \n**[sortable]**", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "rollup": { "description": "Smart rollup to which the operation was sent", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "game": { "description": "Refutation game info", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SrGameInfo" } ] }, "move": { "type": "string", "description": "Player's move (`start`, `dissection`, `proof`, `timeout`)" }, "gameStatus": { "type": "string", "description": "Game status, after player's move (`ongoing`, `loser`, `draw`)" }, "dissectionStart": { "type": "integer", "description": "The first tick in the dissection range. This field is `null` if `move` is not `dissection.", "format": "int64", "nullable": true }, "dissectionEnd": { "type": "integer", "description": "The last tick in the dissection range. This field is `null` if `move` is not `dissection.", "format": "int64", "nullable": true }, "dissectionSteps": { "type": "integer", "description": "Total ticks in the dissection range. This field is `null` if `move` is not `dissection`.", "format": "int32", "nullable": true }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "SrGameInfo": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT id. ", "format": "int64" }, "initiator": { "description": "Initiator, who found a wrong commitment and started the refutation game.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "initiatorCommitment": { "description": "Initiator's version of a valid commitment", "oneOf": [ { "$ref": "#/components/schemas/SrCommitmentInfo" } ] }, "opponent": { "description": "Opponent, who was accused in publishing a wrong commitment.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "opponentCommitment": { "description": "Opponent's version of a valid commitment", "oneOf": [ { "$ref": "#/components/schemas/SrCommitmentInfo" } ] }, "initiatorReward": { "type": "integer", "description": "In case the initiator won, this field will contain the reward amount (in mutez).", "format": "int64", "nullable": true }, "initiatorLoss": { "type": "integer", "description": "In case the initiator lost (including a `draw`), this field will contain the loss amount (in mutez).", "format": "int64", "nullable": true }, "opponentReward": { "type": "integer", "description": "In case the opponent won, this field will contain the reward amount (in mutez).", "format": "int64", "nullable": true }, "opponentLoss": { "type": "integer", "description": "In case the opponent lost (including a `draw`), this field will contain the loss amount (in mutez).", "format": "int64", "nullable": true } } }, "StakingOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `staking`" }, "id": { "type": "integer", "description": "Internal TzKT ID. \n**[sortable]**", "format": "int64" }, "level": { "type": "integer", "description": "Height of the block from the genesis", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime at which the block is claimed to have been created (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "staker": { "description": "Information about the account for which the action is performed", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "action": { "type": "string", "description": "Staking action (`stake`, `unstake`, `finalize`)" }, "requestedAmount": { "type": "integer", "description": "Amount passed as the staking operation parameter (micro tez)", "format": "int64" }, "amount": { "type": "integer", "description": "Actually processed amount (micro tez)", "format": "int64", "nullable": true }, "baker": { "description": "Information about the baker", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "stakingUpdatesCount": { "type": "integer", "description": "Number of staking updates happened internally", "format": "int64", "nullable": true }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "TransactionOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `transaction` - is a standard operation used to transfer tezos tokens to an account" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "initiator": { "description": "Information about the initiator of the transaction call", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "sender": { "description": "Information about the account sent the transaction", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "senderCodeHash": { "type": "integer", "description": "Hash of the sender contract code, or `null` is the sender is not a contract", "format": "int32", "nullable": true }, "nonce": { "type": "integer", "description": "An account nonce which is used to prevent internal operation replay", "format": "int32", "nullable": true }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "storageUsed": { "type": "integer", "description": "Amount of storage, consumed by the operation", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "storageFee": { "type": "integer", "description": "The amount of funds burned from the sender account for used the blockchain storage (micro tez)", "format": "int64" }, "allocationFee": { "type": "integer", "description": "The amount of funds burned from the sender account for account creation (micro tez)", "format": "int64" }, "target": { "description": "Information about the target of the transaction", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "targetCodeHash": { "type": "integer", "description": "Hash of the target contract code, or `null` is the target is not a contract", "format": "int32", "nullable": true }, "amount": { "type": "integer", "description": "The transaction amount (micro tez)", "format": "int64" }, "parameter": { "description": "Transaction parameter, including called entrypoint and value passed to the entrypoint.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TxParameter" } ] }, "storage": { "description": "Contract storage after executing the transaction converted to human-readable JSON. Note: you can configure storage format by setting `micheline` query parameter.", "nullable": true }, "diffs": { "type": "array", "description": "List of bigmap updates (aka big_map_diffs) caused by the transaction.", "nullable": true, "items": { "$ref": "#/components/schemas/BigMapDiff" } }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "hasInternals": { "type": "boolean", "description": "An indication of whether the transaction has an internal operations\n`true` - there are internal operations\n`false` - no internal operations" }, "tokenTransfersCount": { "type": "integer", "description": "Number of token transfers produced by the operation, or `null` if there are no transfers", "format": "int32", "nullable": true }, "ticketTransfersCount": { "type": "integer", "description": "Number of ticket transfers produced by the operation, or `null` if there are no transfers", "format": "int32", "nullable": true }, "eventsCount": { "type": "integer", "description": "Number of events produced by the operation, or `null` if there are no events", "format": "int32", "nullable": true }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "TxParameter": { "type": "object", "additionalProperties": false, "properties": { "entrypoint": { "type": "string", "description": "Entrypoint called on the target contract" }, "value": { "description": "Value passed to the called entrypoint converted to human-readable JSON. Note: you can configure parameters format by setting `micheline` query parameter.", "nullable": true } } }, "TransferTicketOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `transfer_ticket`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "storageUsed": { "type": "integer", "description": "Amount of storage, consumed by the operation", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "storageFee": { "type": "integer", "description": "The amount of funds burned from the sender account for used the blockchain storage (micro tez)", "format": "int64" }, "target": { "description": "Information about the target to which the operation was sent", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "ticketer": { "description": "Information about the ticketer", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "amount": { "type": "string", "description": "Amount sent" }, "entrypoint": { "type": "string", "description": "Entrypoint" }, "ticketTransfersCount": { "type": "integer", "description": "Number of ticket transfers produced by the operation, or `null` if there are no transfers", "format": "int32", "nullable": true }, "contentType": { "description": "Micheline type of the content", "nullable": true }, "content": { "description": "Ticket content", "nullable": true }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "TxRollupCommitOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `tx_rollup_commit`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "rollup": { "description": "Information about the rollup to which the operation was sent", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "bond": { "type": "integer", "description": "Amount of bonds (micro tez) locked", "format": "int64" }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "TxRollupDispatchTicketsOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `tx_rollup_dispatch_tickets`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "storageUsed": { "type": "integer", "description": "Amount of storage, consumed by the operation", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "storageFee": { "type": "integer", "description": "The amount of funds burned from the sender account for used the blockchain storage (micro tez)", "format": "int64" }, "rollup": { "description": "Information about the rollup to which the operation was sent", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "TxRollupFinalizeCommitmentOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `tx_rollup_finalize_commitment`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "rollup": { "description": "Information about the rollup to which the operation was sent", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "TxRollupOriginationOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `tx_rollup_origination`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "allocationFee": { "type": "integer", "description": "The amount of funds burned from the sender account for account creation (micro tez)", "format": "int64" }, "rollup": { "description": "Information about the rollup to which the operation was sent", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "TxRollupRejectionOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `tx_rollup_rejection`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "rollup": { "description": "Information about the rollup to which the operation was sent", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "committer": { "description": "Information about the committer", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "reward": { "type": "integer", "description": "Reward (micro tez) sent to the rejection sender", "format": "int64" }, "loss": { "type": "integer", "description": "Loss (micro tez) burned from the committer", "format": "int64" }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "TxRollupRemoveCommitmentOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `tx_rollup_remove_commitment`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "rollup": { "description": "Information about the rollup to which the operation was sent", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "TxRollupReturnBondOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `tx_rollup_return_bond`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "rollup": { "description": "Information about the rollup to which the operation was sent", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "bond": { "type": "integer", "description": "Amount of bonds unlocked (micro tez)", "format": "int64" }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "TxRollupSubmitBatchOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `tx_rollup_submit_batch`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "storageUsed": { "type": "integer", "description": "Amount of storage, consumed by the operation", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "storageFee": { "type": "integer", "description": "The amount of funds burned from the sender account for used the blockchain storage (micro tez)", "format": "int64" }, "rollup": { "description": "Information about the rollup to which the operation was sent", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "UpdateSecondaryKeyOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `update_secondary_key`" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "sender": { "description": "Information about the account who has sent the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "counter": { "type": "integer", "description": "An account nonce which is used to prevent operation replay", "format": "int32" }, "gasLimit": { "type": "integer", "description": "A cap on the amount of gas a given operation can consume", "format": "int32" }, "gasUsed": { "type": "integer", "description": "Amount of gas, consumed by the operation", "format": "int32" }, "storageLimit": { "type": "integer", "description": "A cap on the amount of storage a given operation can consume", "format": "int32" }, "bakerFee": { "type": "integer", "description": "Fee to the baker, produced block, in which the operation was included (micro tez)", "format": "int64" }, "status": { "type": "string", "description": "Operation status (`applied` - an operation applied by the node and successfully added to the blockchain,\n`failed` - an operation which failed with some particular error (not enough balance, gas limit, etc),\n`backtracked` - an operation which was successful but reverted due to one of the following operations in the same operation group was failed,\n`skipped` - all operations after the failed one in an operation group)" }, "keyType": { "type": "string", "description": "Type of the key: `consensus` or `companion`" }, "activationCycle": { "type": "integer", "description": "Index of the cycle from which the secondary key will be active", "format": "int32" }, "publicKey": { "type": "string", "description": "Secondary key" }, "publicKeyHash": { "type": "string", "description": "Secondary key hash" }, "errors": { "type": "array", "description": "List of errors provided by the node, injected the operation to the blockchain. `null` if there is no errors", "nullable": true, "items": { "$ref": "#/components/schemas/OperationError" } }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "VdfRevelationOperation": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the operation, `vdf_revelation` - used by the blockchain to create randomness" }, "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "block": { "type": "string", "description": "Hash of the block, in which the operation was included" }, "hash": { "type": "string", "description": "Hash of the operation" }, "baker": { "description": "Information about the delegate (baker), who produced the block with the operation", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "cycle": { "type": "integer", "description": "Cycle in which the operation was included", "format": "int32" }, "solution": { "type": "string", "description": "Vdf solution" }, "proof": { "type": "string", "description": "Vdf proof" }, "rewardDelegated": { "type": "integer", "description": "Reward, corresponding to delegated stake, paid to baker's liquid balance (micro tez)\n(it is not frozen and can be spent immediately).", "format": "int64" }, "rewardStakedOwn": { "type": "integer", "description": "Reward, corresponding to baker's own stake, paid to baker's own staked balance (micro tez)\n(it is frozen and belongs to the baker).", "format": "int64" }, "rewardStakedEdge": { "type": "integer", "description": "Reward, corresponding to baker's edge from external stake, paid to baker's own staked balance (micro tez)\n(it is frozen and belongs to the baker).", "format": "int64" }, "rewardStakedShared": { "type": "integer", "description": "Reward, corresponding to baker's external stake, paid to baker's external staked balance (micro tez)\n(it is frozen and belongs to baker's stakers).", "format": "int64" }, "quote": { "description": "Injected historical quote at the time of operation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } } ] }, "TicketTransferActivity": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Activity type" }, "id": { "type": "integer", "description": "Internal TzKT id. \n**[sortable]**", "format": "int64" }, "level": { "type": "integer", "description": "Level of the block, at which the transfer was made. \n**[sortable]**", "format": "int32" }, "timestamp": { "type": "string", "description": "Timestamp of the block, at which the transfer was made.", "format": "date-time" }, "ticket": { "description": "Ticket info. \nClick on the field to expand more details.", "oneOf": [ { "$ref": "#/components/schemas/TicketInfo" } ] }, "from": { "description": "Sender account. \nClick on the field to expand more details.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "to": { "description": "Recipient account. \nClick on the field to expand more details.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "amount": { "type": "string", "description": "Amount of tickets transferred. \n**[sortable]**" }, "transactionId": { "type": "integer", "description": "Internal TzKT id of the transaction operation, caused the ticket transfer.", "format": "int64", "nullable": true }, "transferTicketId": { "type": "integer", "description": "Internal TzKT id of the transfer_ticket operation, caused the ticket transfer.", "format": "int64", "nullable": true }, "smartRollupExecuteId": { "type": "integer", "description": "Internal TzKT id of the smart_rollup_execute operation, caused the ticket transfer.", "format": "int64", "nullable": true } } } ] }, "TicketInfo": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT id.", "format": "int64" }, "ticketer": { "description": "Contract, issued the ticket.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "rawType": { "description": "Ticket content type in Micheline format.", "oneOf": [ { "$ref": "#/components/schemas/IMicheline" } ] }, "rawContent": { "description": "Ticket content in Micheline format.", "oneOf": [ { "$ref": "#/components/schemas/IMicheline" } ] }, "content": { "description": "Ticket content in JSON format.", "nullable": true }, "typeHash": { "type": "integer", "description": "32-bit hash of the ticket content type.", "format": "int32" }, "contentHash": { "type": "integer", "description": "32-bit hash of the ticket content.", "format": "int32" }, "totalSupply": { "type": "string", "description": "Total amount exists." } } }, "IMicheline": { "type": "object", "x-abstract": true, "additionalProperties": false, "properties": { "type": { "$ref": "#/components/schemas/MichelineType" } } }, "MichelineType": { "type": "integer", "description": "", "x-enumNames": [ "Int", "Bytes", "String", "Array", "Prim" ], "enum": [ 0, 32, 64, 96, 128 ] }, "TokenTransferActivity": { "allOf": [ { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Activity type" }, "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 } } } ] }, "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 } } }, "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`). \\\nSpecify a datetime value to get items where the specified field is equal to the specified value.\n\nExample: `?timestamp=2020-02-20T02:40:57Z`.", "format": "date-time", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify a datetime value to get items where the specified field is not equal to the specified value.\n\nExample: `?timestamp.ne=2020-02-20T02:40:57Z`.", "format": "date-time", "nullable": true }, "gt": { "type": "string", "description": "**Greater than** filter mode. \\\nSpecify a datetime value to get items where the specified field is greater than the specified value.\n\nExample: `?timestamp.gt=2020-02-20T02:40:57Z`.", "format": "date-time", "nullable": true }, "ge": { "type": "string", "description": "**Greater or equal** filter mode. \\\nSpecify a datetime value to get items where the specified field is greater than equal to the specified value.\n\nExample: `?timestamp.ge=2020-02-20T02:40:57Z`.", "format": "date-time", "nullable": true }, "lt": { "type": "string", "description": "**Less than** filter mode. \\\nSpecify a datetime value to get items where the specified field is less than the specified value.\n\nExample: `?timestamp.lt=2020-02-20T02:40:57Z`.", "format": "date-time", "nullable": true }, "le": { "type": "string", "description": "**Less or equal** filter mode. \\\nSpecify a datetime value to get items where the specified field is less than or equal to the specified value.\n\nExample: `?timestamp.le=2020-02-20T02:40:57Z`.", "format": "date-time", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of datetimes to get items where the specified field is equal to one of the specified values.\n\nExample: `?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. \\\nSpecify a comma-separated list of datetimes to get items where the specified field is not equal to all the specified values.\n\nExample: `?timestamp.ni=2020-02-20,2020-02-21`.", "nullable": true, "items": { "type": "string", "format": "date-time" } } }, "x-tzkt-extension": "query-parameter" }, "SortMode": { "type": "string", "description": "", "x-enumNames": [ "Ascending", "Descending" ], "enum": [ "Ascending", "Descending" ] }, "MichelineFormat": { "type": "string", "description": "", "x-enumNames": [ "Json", "JsonString", "Raw", "RawString" ], "enum": [ "Json", "JsonString", "Raw", "RawString" ] }, "Symbols": { "type": "string", "description": "", "x-enumFlags": true, "x-enumNames": [ "None", "Btc", "Eur", "Usd", "Cny", "Jpy", "Krw", "Eth", "Gbp" ], "enum": [ "None", "Btc", "Eur", "Usd", "Cny", "Jpy", "Krw", "Eth", "Gbp" ] }, "RelatedContract": { "type": "object", "additionalProperties": false, "properties": { "kind": { "type": "string", "description": "Kind of the contract (`delegator_contract` or `smart_contract`),\nwhere `delegator_contract` - manager.tz smart contract for delegation purpose only" }, "alias": { "type": "string", "description": "Name of the project behind the contract or contract description", "nullable": true }, "address": { "type": "string", "description": "Public key hash of the contract" }, "balance": { "type": "integer", "description": "Contract balance (micro tez)", "format": "int64" }, "delegate": { "description": "Information about the current delegate of the contract. `null` if it's not delegated", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DelegateInfo" } ] }, "creationLevel": { "type": "integer", "description": "Height of the block where the contract was created", "format": "int32" }, "creationTime": { "type": "string", "description": "Datetime of the block where the contract was created (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time", "nullable": true } } }, "Delegator": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Delegator type ('contract' for KT.. address or 'user' for tz.. address)" }, "alias": { "type": "string", "description": "Name of the project behind the account or account description", "nullable": true }, "address": { "type": "string", "description": "Public key hash of the account" }, "balance": { "type": "integer", "description": "Account balance (micro tez)", "format": "int64" }, "delegationLevel": { "type": "integer", "description": "Block height of last delegation operation", "format": "int32" }, "delegationTime": { "type": "string", "description": "Block datetime of last delegation operation (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" } } }, "HistoricalBalance": { "type": "object", "additionalProperties": false, "properties": { "level": { "type": "integer", "description": "Height of the block at which the account balance was calculated", "format": "int32" }, "timestamp": { "type": "string", "description": "Timestamp of the block at which the account balance was calculated", "format": "date-time" }, "balance": { "type": "integer", "description": "Historical balance", "format": "int64" }, "quote": { "description": "Injected historical quote at the time of balance snapshot", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } }, "BigMap": { "type": "object", "additionalProperties": false, "properties": { "ptr": { "type": "integer", "description": "Bigmap pointer", "format": "int32" }, "contract": { "description": "Smart contract in which's storage the bigmap is allocated", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "path": { "type": "string", "description": "Path to the bigmap in the contract storage " }, "tags": { "type": "array", "description": "List of tags ( `metadata`, `token_metadata`,`ledger`, or `null` if there are no tags)", "nullable": true, "items": { "type": "string" } }, "active": { "type": "boolean", "description": "Bigmap status (`true` - active, `false` - removed)" }, "firstLevel": { "type": "integer", "description": "Level of the block where the bigmap was seen first time", "format": "int32" }, "lastLevel": { "type": "integer", "description": "Level of the block where the bigmap was seen last time", "format": "int32" }, "totalKeys": { "type": "integer", "description": "Total number of keys ever added to the bigmap", "format": "int32" }, "activeKeys": { "type": "integer", "description": "Total number of currently active keys", "format": "int32" }, "updates": { "type": "integer", "description": "Total number of actions with the bigmap", "format": "int32" }, "keyType": { "description": "Bigmap key type as JSON schema or Micheline, depending on the `micheline` query parameter." }, "valueType": { "description": "Bigmap value type as JSON schema or Micheline, depending on the `micheline` query parameter." } } }, "StringParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify a string to get items where the specified field is equal to the specified value.\n\nExample: `?parameters=abc`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify a string to get items where the specified field is not equal to the specified value.\n\nExample: `?parameters.ne=abc`.", "nullable": true }, "as": { "type": "string", "description": "**Same as** filter mode. \\\nSpecify a string template to get items where the specified field matches the specified template. \\\nThis mode supports wildcard `*`. Use `\\*` as an escape symbol.\n\nExample: `?parameters.as=*mid*` or `?parameters.as=*end`.", "nullable": true }, "un": { "type": "string", "description": "**Unlike** filter mode. \\\nSpecify a string template to get items where the specified field doesn't match the specified template.\nThis mode supports wildcard `*`. Use `\\*` as an escape symbol.\n\nExample: `?parameters.un=*mid*` or `?parameters.un=*end`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of strings to get items where the specified field is equal to one of the specified values. \\\nUse `\\,` as an escape symbol.\n\nExample: `?errors.in=bla,bal,abl`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of strings to get items where the specified field is not equal to all the specified values. \\\nUse `\\,` as an escape symbol.\n\nExample: `?errors.ni=bla,bal,abl`.", "nullable": true, "items": { "type": "string" } }, "null": { "type": "boolean", "description": "**Is null** filter mode. \\\nUse this mode to get items where the specified field is null or not.\n\nExample: `?parameters.null` or `?parameters.null=false`.", "nullable": true } }, "x-tzkt-extension": "query-parameter" }, "BigMapTagsParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "array", "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify a comma-separated list of bigmap tags to get bigmaps with exactly the same set of tags.\nAvoid using this mode and use `.any` or `.all` instead, because it may not work as expected due to internal 'hidden' tags.\n\nExample: `?tags=metadata` or `?tags=token_metadata,metadata`.", "nullable": true, "items": { "type": "string" } }, "any": { "type": "array", "description": "**Has any** filter mode. \\\nSpecify a comma-separated list of bigmap tags to get bigmaps where at least one of the specified tags is presented.\n\nExample: `?tags.any=metadata` or `?tags.any=token_metadata,metadata`.", "nullable": true, "items": { "type": "string" } }, "all": { "type": "array", "description": "**Has all** filter mode. \\\nSpecify a comma-separated list of bigmap tags to get bigmaps where all of the specified tags are presented.\n\nExample: `?tags.all=metadata` or `?tags.all=token_metadata,metadata`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "metadata,token_metadata,ledger" }, "BigMapKeyFull": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT id. \n**[sortable]**", "format": "int32" }, "bigmap": { "type": "integer", "description": "Bigmap ptr.", "format": "int32" }, "active": { "type": "boolean", "description": "Key status (`true` - active, `false` - removed)." }, "hash": { "type": "string", "description": "Key hash." }, "key": { "description": "Key in JSON or Micheline format, depending on the `micheline` query parameter. \n**[sortable]**" }, "value": { "description": "Value in JSON or Micheline format, depending on the `micheline` query parameter.\nNote, if the key is inactive (removed) this field will contain the last non-null value. \n**[sortable]**" }, "firstLevel": { "type": "integer", "description": "Level of the block where the key was first seen. \n**[sortable]**", "format": "int32" }, "firstTime": { "type": "string", "description": "Timestamp of the block where the key was first seen.", "format": "date-time" }, "lastLevel": { "type": "integer", "description": "Level of the block where the key was last seen. \n**[sortable]**", "format": "int32" }, "lastTime": { "type": "string", "description": "Timestamp of the block where the key was last seen.", "format": "date-time" }, "updates": { "type": "integer", "description": "Total number of actions with the key. \n**[sortable]**", "format": "int32" } } }, "ExpressionParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify an expression hash to get items where the specified field is equal to the specified value.\n\nExample: `?address=expr...`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify an expression hash to get items where the specified field is not equal to the specified value.\n\nExample: `?address.ne=expr...`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of expression hashes to get items where the specified field is equal to one of the specified values.\n\nExample: `?address.in=expr1,expr2`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of expression hashes to get items where the specified field is not equal to all the specified values.\n\nExample: `?address.ni=expr1,expr2`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-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`). \\\nSpecify a JSON value to get items where the specified field is equal to the specified value.\n\nExample: `?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. \\\nSpecify a JSON value to get items where the specified field is not equal to the specified value.\n\nExample: `?parameter.ne=true` or `?parameter.amount.ne=0`.", "nullable": true, "x-tzkt-extension": "json-parameter" }, "gt": { "type": "string", "description": "**Greater than** filter mode. \\\nSpecify a string to get items where the specified field is greater than the specified value.\nNote 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,\ne.g. numeric strings with numeric strings (`parameter.number.gt=123`), datetime strings with datetime strings (`parameter.date.gt=2021-01-01`), etc.\nOtherwise, result may surprise you.\n\nExample: `?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. \\\nSpecify a string to get items where the specified field is greater than equal to the specified value.\nNote 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,\ne.g. numeric strings with numeric strings (`parameter.number.gt=123`), datetime strings with datetime strings (`parameter.date.gt=2021-01-01`), etc.\nOtherwise, result may surprise you.\n\nExample: `?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. \\\nSpecify a string to get items where the specified field is less than the specified value.\nNote 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,\ne.g. numeric strings with numeric strings (`parameter.number.gt=123`), datetime strings with datetime strings (`parameter.date.gt=2021-01-01`), etc.\nOtherwise, result may surprise you.\n\nExample: `?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. \\\nSpecify a string to get items where the specified field is less than or equal to the specified value.\nNote 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,\ne.g. numeric strings with numeric strings (`parameter.number.gt=123`), datetime strings with datetime strings (`parameter.date.gt=2021-01-01`), etc.\nOtherwise, result may surprise you.\n\nExample: `?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. \\\nSpecify a string template to get items where the specified field matches the specified template. \\\nThis mode supports wildcard `*`. Use `\\*` as an escape symbol.\n\nExample: `?parameter.as=*mid*` or `?parameter.as=*end`.", "nullable": true, "x-tzkt-extension": "json-parameter" }, "un": { "type": "string", "description": "**Unlike** filter mode. \\\nSpecify a string template to get items where the specified field doesn't match the specified template.\nThis mode supports wildcard `*`. Use `\\*` as an escape symbol.\n\nExample: `?parameter.un=*mid*` or `?parameter.un=*end`.", "nullable": true, "x-tzkt-extension": "json-parameter" }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of strings or JSON array to get items where the specified field is equal to one of the specified values. \\\n\nExample: `?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. \\\nSpecify a comma-separated list of strings to get items where the specified field is not equal to all the specified values. \\\nUse `\\,` as an escape symbol.\n\nExample: `?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. \\\nUse this mode to get items where the specified field is null or not.\n\nExample: `?parameter.null` or `?parameter.null=false` or `?parameter.sigs.[0].null=false`.", "x-tzkt-extension": "json-parameter" } }, "x-tzkt-extension": "json-parameter" }, "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`). \\\nSpecify a comma-separated list of fields to include into response.\n\nExample:\n`?select=address,balance as b,metadata.name as meta_name` will result in\n`[ { \"address\": \"asd\", \"b\": 10, \"meta_name\": \"qwe\" } ]`.", "nullable": true, "items": { "type": "string" } }, "values": { "type": "array", "description": "**Values** selection mode. \\\nSpecify a comma-separated list of fields to include their values into response.\n\nExample:\n`?select.values=address,balance,metadata.name` will result in\n`[ [ \"asd\", 10, \"qwe\" ] ]`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter" }, "BigMapUpdate": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal Id, can be used for pagination", "format": "int32" }, "level": { "type": "integer", "description": "Level of the block where the bigmap was updated", "format": "int32" }, "timestamp": { "type": "string", "description": "Timestamp of the block where the bigmap was updated", "format": "date-time" }, "bigmap": { "type": "integer", "description": "Bigmap ptr", "format": "int32" }, "contract": { "description": "Smart contract in which's storage the bigmap is allocated", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "path": { "type": "string", "description": "Path to the bigmap in the contract storage" }, "action": { "type": "string", "description": "Action with the bigmap (`allocate`, `add_key`, `update_key`, `remove_key`, `remove`)" }, "content": { "description": "Updated key.\nIf the action is `allocate` or `remove` the content will be `null`.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/BigMapKeyShort" } ] } } }, "BigMapActionParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify a contract kind to get items where the specified field is equal to the specified value.\n\nExample: `?kind=smart_contract`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify a contract kind to get items where the specified field is not equal to the specified value.\n\nExample: `?kind.ne=delegator_contract`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of contract kinds to get items where the specified field is equal to one of the specified values.\n\nExample: `?kind.in=smart_contract,asset`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of contract kinds to get items where the specified field is not equal to all the specified values.\n\nExample: `?kind.ni=smart_contract,asset`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "allocate,add_key,update_key,remove_key,remove" }, "MichelinePrim": { "type": "object", "additionalProperties": false, "properties": { "prim": { "$ref": "#/components/schemas/PrimType" }, "args": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/IMicheline" } }, "annots": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/IAnnotation" } } } }, "PrimType": { "type": "integer", "description": "", "x-enumNames": [ "parameter", "storage", "code", "False", "Elt", "Left", "None", "Pair", "Right", "Some", "True", "Unit", "PACK", "UNPACK", "BLAKE2B", "SHA256", "SHA512", "ABS", "ADD", "AMOUNT", "AND", "BALANCE", "CAR", "CDR", "CHECK_SIGNATURE", "COMPARE", "CONCAT", "CONS", "CREATE_ACCOUNT", "CREATE_CONTRACT", "IMPLICIT_ACCOUNT", "DIP", "DROP", "DUP", "EDIV", "EMPTY_MAP", "EMPTY_SET", "EQ", "EXEC", "FAILWITH", "GE", "GET", "GT", "HASH_KEY", "IF", "IF_CONS", "IF_LEFT", "IF_NONE", "INT", "LAMBDA", "LE", "LEFT", "LOOP", "LSL", "LSR", "LT", "MAP", "MEM", "MUL", "NEG", "NEQ", "NIL", "NONE", "NOT", "NOW", "OR", "PAIR", "PUSH", "RIGHT", "SIZE", "SOME", "SOURCE", "SENDER", "SELF", "STEPS_TO_QUOTA", "SUB", "SWAP", "TRANSFER_TOKENS", "SET_DELEGATE", "UNIT", "UPDATE", "XOR", "ITER", "LOOP_LEFT", "ADDRESS", "CONTRACT", "ISNAT", "CAST", "RENAME", "bool", "contract", "int", "key", "key_hash", "lambda", "list", "map", "big_map", "nat", "option", "or", "pair", "set", "signature", "string", "bytes", "mutez", "timestamp", "unit", "operation", "address", "SLICE", "DIG", "DUG", "EMPTY_BIG_MAP", "APPLY", "chain_id", "CHAIN_ID", "LEVEL", "SELF_ADDRESS", "never", "NEVER", "UNPAIR", "VOTING_POWER", "TOTAL_VOTING_POWER", "KECCAK", "SHA3", "PAIRING_CHECK", "bls12_381_g1", "bls12_381_g2", "bls12_381_fr", "sapling_state", "sapling_transaction_deprecated", "SAPLING_EMPTY_STATE", "SAPLING_VERIFY_UPDATE", "ticket", "TICKET_DEPRECATED", "READ_TICKET", "SPLIT_TICKET", "JOIN_TICKETS", "GET_AND_UPDATE", "chest", "chest_key", "OPEN_CHEST", "VIEW", "view", "constant", "SUB_MUTEZ", "tx_rollup_l2_address", "MIN_BLOCK_TIME", "sapling_transaction", "EMIT", "Lambda_rec", "LAMBDA_REC", "TICKET", "BYTES", "NAT", "Ticket", "IS_IMPLICIT_ACCOUNT", "GET_ADDRESS_INDEX", "INDEX_ADDRESS" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 153, 154, 155, 156, 157, 158, 159, 160 ] }, "IAnnotation": { "type": "object", "x-abstract": true, "additionalProperties": false, "properties": { "type": { "$ref": "#/components/schemas/AnnotationType" }, "value": { "type": "string" } } }, "AnnotationType": { "type": "integer", "description": "", "x-enumNames": [ "Unsafe", "Field", "Type", "Variable" ], "enum": [ 0, 64, 128, 192 ] }, "BigMapKey": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal Id, can be used for pagination", "format": "int32" }, "active": { "type": "boolean", "description": "Bigmap key status (`true` - active, `false` - removed)" }, "hash": { "type": "string", "description": "Key hash" }, "key": { "description": "Key in JSON or Micheline format, depending on the `micheline` query parameter." }, "value": { "description": "Value in JSON or Micheline format, depending on the `micheline` query parameter.\nNote, if the key is inactive (removed) it will contain the last non-null value." }, "firstLevel": { "type": "integer", "description": "Level of the block where the bigmap key was seen first time", "format": "int32" }, "lastLevel": { "type": "integer", "description": "Level of the block where the bigmap key was seen last time", "format": "int32" }, "updates": { "type": "integer", "description": "Total number of actions with the bigmap key", "format": "int32" } } }, "BigMapKeyUpdate": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal Id, can be used for pagination", "format": "int32" }, "level": { "type": "integer", "description": "Level of the block where the bigmap key was updated", "format": "int32" }, "timestamp": { "type": "string", "description": "Timestamp of the block where the bigmap key was updated", "format": "date-time" }, "action": { "type": "string", "description": "Action with the key (`add_key`, `update_key`, `remove_key`)" }, "value": { "description": "Value in JSON or Micheline format, depending on the `micheline` query parameter.\nNote, if the action is `remove_key` it will contain the last non-null value." } } }, "BigMapKeyHistorical": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal Id, can be used for pagination", "format": "int32" }, "active": { "type": "boolean", "description": "Bigmap key status (`true` - active, `false` - removed)" }, "hash": { "type": "string", "description": "Key hash" }, "key": { "description": "Key in JSON or Micheline format, depending on the `micheline` query parameter." }, "value": { "description": "Value in JSON or Micheline format, depending on the `micheline` query parameter.\nNote, if the key is inactive (removed) it will contain the last non-null value." } } }, "Block": { "type": "object", "additionalProperties": false, "properties": { "cycle": { "type": "integer", "description": "Index of the cycle", "format": "int32" }, "level": { "type": "integer", "description": "Height of the block from the genesis", "format": "int32" }, "hash": { "type": "string", "description": "Block hash" }, "timestamp": { "type": "string", "description": "Datetime at which the block is claimed to have been created (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "proto": { "type": "integer", "description": "Protocol code, representing a number of protocol changes since genesis (mod 256, but `-1` for the genesis block)", "format": "int32" }, "payloadRound": { "type": "integer", "description": "Round at which the block payload was proposed", "format": "int32" }, "blockRound": { "type": "integer", "description": "Round at which the block was produced", "format": "int32" }, "attestationPower": { "type": "integer", "description": "Recorder attestation power", "format": "int64" }, "attestationCommittee": { "type": "integer", "description": "Total attestation committee power", "format": "int64" }, "deposit": { "type": "integer", "description": "Security deposit frozen on the baker's account for producing the block (micro tez)", "format": "int64" }, "rewardDelegated": { "type": "integer", "description": "Portion of fixed reward, corresponding to delegated stake, paid to payload proposer's liquid balance (micro tez)\n(it is not frozen and can be spent immediately).", "format": "int64" }, "rewardStakedOwn": { "type": "integer", "description": "Portion of fixed reward, corresponding to baker's own stake, paid to payload proposer's own staked balance (micro tez)\n(it is frozen and belongs to the baker).", "format": "int64" }, "rewardStakedEdge": { "type": "integer", "description": "Portion of fixed reward, corresponding to baker's edge from external stake, paid to payload proposer's own staked balance (micro tez)\n(it is frozen and belongs to the baker).", "format": "int64" }, "rewardStakedShared": { "type": "integer", "description": "Portion of fixed reward, corresponding to baker's external stake, paid to payload proposer's external staked balance (micro tez)\n(it is frozen and belongs to baker's stakers).", "format": "int64" }, "bonusDelegated": { "type": "integer", "description": "Portion of bonus reward, corresponding to delegated stake, paid to block producer's liquid balance (micro tez)\n(it is not frozen and can be spent immediately).", "format": "int64" }, "bonusStakedOwn": { "type": "integer", "description": "Portion of bonus reward, corresponding to baker's own stake, paid to block producer's own staked balance (micro tez)\n(it is frozen and belongs to the baker).", "format": "int64" }, "bonusStakedEdge": { "type": "integer", "description": "Portion of bonus reward, corresponding to baker's edge from external stake, paid to block producer's own staked balance (micro tez)\n(it is frozen and belongs to the baker).", "format": "int64" }, "bonusStakedShared": { "type": "integer", "description": "Portion of fixed reward, corresponding to baker's external stake, paid to block producer's external staked balance (micro tez)\n(it is frozen and belongs to baker's stakers).", "format": "int64" }, "fees": { "type": "integer", "description": "Total fee gathered from operations, included into the block", "format": "int64" }, "nonceRevealed": { "type": "boolean", "description": "Status of the seed nonce revelation\n`true` - seed nonce revealed\n`false` - there's no `seed_nonce_hash` in the block or seed nonce revelation has missed" }, "proposer": { "description": "Baker who proposed the block payload", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "producer": { "description": "Baker who produced the block", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "software": { "description": "Information about baker's software", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SoftwareAlias" } ] }, "lbToggle": { "type": "boolean", "description": "Liquidity baking toggle (`true` if enabled, `false` if disabled, or `null` if the baker says 'pass')", "nullable": true }, "lbToggleEma": { "type": "integer", "description": "Liquidity baking escape EMA value with precision of 1000000 for integer computation", "format": "int32" }, "attestations": { "type": "array", "description": "List of attestation (is operation, which specifies the head of the chain as seen by the attester of a given slot)\noperations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/AttestationOperation" } }, "preattestations": { "type": "array", "description": "List of preattestation operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/PreattestationOperation" } }, "proposals": { "type": "array", "description": "List of proposal (is used by bakers (delegates) to submit and/or upvote proposals to amend the protocol)\noperations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/ProposalOperation" } }, "ballots": { "type": "array", "description": "List of ballot (is used to vote for a proposal in a given voting cycle) operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/BallotOperation" } }, "activations": { "type": "array", "description": "List of activation (is used to activate accounts that were recommended allocations of\ntezos tokens for donations to the Tezos Foundation’s fundraiser) operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/ActivationOperation" } }, "dalEntrapmentEvidenceOps": { "type": "array", "description": "List of dal entrapment evidence operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/DalEntrapmentEvidenceOperation" } }, "doubleBaking": { "type": "array", "description": "List of double baking evidence (is used by bakers to provide evidence of double baking (baking two different\nblocks at the same height) by a baker) operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/DoubleBakingOperation" } }, "doubleConsensus": { "type": "array", "description": "List of double consensus evidence (is used by bakers to provide evidence of double (pre)attestation\n((pre)attestation of two different blocks at the same block height) by a baker) operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/DoubleConsensusOperation" } }, "nonceRevelations": { "type": "array", "description": "List of nonce revelation (used by the blockchain to create randomness) operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/NonceRevelationOperation" } }, "vdfRevelations": { "type": "array", "description": "List of vdf revelation (used by the blockchain to create randomness) operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/VdfRevelationOperation" } }, "delegations": { "type": "array", "description": "List of delegation (is used to delegate funds to a delegate (an implicit account registered as a baker))\noperations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/DelegationOperation" } }, "originations": { "type": "array", "description": "List of origination (deployment / contract creation ) operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/OriginationOperation" } }, "transactions": { "type": "array", "description": "List of transaction (is a standard operation used to transfer tezos tokens to an account)\noperations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/TransactionOperation" } }, "reveals": { "type": "array", "description": "List of reveal (is used to reveal the public key associated with an account) operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/RevealOperation" } }, "registerConstants": { "type": "array", "description": "List of register global constant operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/RegisterConstantOperation" } }, "setDepositsLimits": { "type": "array", "description": "List of set deposits limit operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/SetDepositsLimitOperation" } }, "transferTicketOps": { "type": "array", "description": "List of transfer ticket operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/TransferTicketOperation" } }, "txRollupCommitOps": { "type": "array", "description": "List of tx rollup commit operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/TxRollupCommitOperation" } }, "txRollupDispatchTicketsOps": { "type": "array", "description": "List of tx rollup dispatch tickets operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/TxRollupDispatchTicketsOperation" } }, "txRollupFinalizeCommitmentOps": { "type": "array", "description": "List of tx rollup finalize commitment operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/TxRollupFinalizeCommitmentOperation" } }, "txRollupOriginationOps": { "type": "array", "description": "List of tx rollup origination operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/TxRollupOriginationOperation" } }, "txRollupRejectionOps": { "type": "array", "description": "List of tx rollup rejection operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/TxRollupRejectionOperation" } }, "txRollupRemoveCommitmentOps": { "type": "array", "description": "List of tx rollup remove commitment operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/TxRollupRemoveCommitmentOperation" } }, "txRollupReturnBondOps": { "type": "array", "description": "List of tx rollup return bond operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/TxRollupReturnBondOperation" } }, "txRollupSubmitBatchOps": { "type": "array", "description": "List of tx rollup submit batch operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/TxRollupSubmitBatchOperation" } }, "increasePaidStorageOps": { "type": "array", "description": "List of increase paid storage operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/IncreasePaidStorageOperation" } }, "updateSecondaryKeyOps": { "type": "array", "description": "List of update secondary key operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/UpdateSecondaryKeyOperation" } }, "drainDelegateOps": { "type": "array", "description": "List of drain delegate operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/DrainDelegateOperation" } }, "srAddMessagesOps": { "type": "array", "description": "List of smart rollup add messages operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/SmartRollupAddMessagesOperation" } }, "srCementOps": { "type": "array", "description": "List of smart rollup cement operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/SmartRollupCementOperation" } }, "srExecuteOps": { "type": "array", "description": "List of smart rollup execute operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/SmartRollupExecuteOperation" } }, "srOriginateOps": { "type": "array", "description": "List of smart rollup originate operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/SmartRollupOriginateOperation" } }, "srPublishOps": { "type": "array", "description": "List of smart rollup publish operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/SmartRollupPublishOperation" } }, "srRecoverBondOps": { "type": "array", "description": "List of smart rollup recover bond operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/SmartRollupRecoverBondOperation" } }, "srRefuteOps": { "type": "array", "description": "List of smart rollup refute operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/SmartRollupRefuteOperation" } }, "stakingOps": { "type": "array", "description": "List of staking operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/StakingOperation" } }, "setDelegateParametersOps": { "type": "array", "description": "List of set delegate parameters operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/SetDelegateParametersOperation" } }, "dalPublishCommitmentOps": { "type": "array", "description": "List of DAL publish commitment operations, included in the block", "nullable": true, "items": { "$ref": "#/components/schemas/DalPublishCommitmentOperation" } }, "migrations": { "type": "array", "description": "List of migration operations, implicitly applied at the end of the block", "nullable": true, "items": { "$ref": "#/components/schemas/MigrationOperation" } }, "revelationPenalties": { "type": "array", "description": "List of revelation penalty operations, implicitly applied at the end of the block", "nullable": true, "items": { "$ref": "#/components/schemas/RevelationPenaltyOperation" } }, "attestationRewards": { "type": "array", "description": "List of attestation rewards, implicitly applied at the end of the block", "nullable": true, "items": { "$ref": "#/components/schemas/AttestationRewardOperation" } }, "dalAttestationRewards": { "type": "array", "description": "List of dal attestation rewards, implicitly applied at the end of the block", "nullable": true, "items": { "$ref": "#/components/schemas/DalAttestationRewardOperation" } }, "autostakingOps": { "type": "array", "description": "List of autostaking operations, implicitly applied at the end of the block", "nullable": true, "items": { "$ref": "#/components/schemas/AutostakingOperation" } }, "quote": { "description": "Injected historical quote at the time of block", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] }, "validations": { "type": "integer", "description": "**DEPRECATED**", "format": "int32" }, "aiToggle": { "type": "boolean", "description": "**DEPRECATED**", "nullable": true }, "aiToggleEma": { "type": "integer", "description": "**DEPRECATED**", "format": "int32" }, "updateConsensusKeyOps": { "type": "array", "description": "**DEPRECATED**", "nullable": true, "items": { "$ref": "#/components/schemas/UpdateSecondaryKeyOperation" } }, "endorsements": { "type": "array", "description": "**DEPRECATED**", "nullable": true, "items": { "$ref": "#/components/schemas/AttestationOperation" } }, "preendorsements": { "type": "array", "description": "**DEPRECATED**", "nullable": true, "items": { "$ref": "#/components/schemas/PreattestationOperation" } }, "doubleEndorsing": { "type": "array", "description": "**DEPRECATED**", "nullable": true, "items": { "$ref": "#/components/schemas/DoubleConsensusOperation" } }, "doublePreendorsing": { "type": "array", "description": "**DEPRECATED**", "nullable": true, "items": { "$ref": "#/components/schemas/DoubleConsensusOperation" } }, "endorsingRewards": { "type": "array", "description": "**DEPRECATED**", "nullable": true, "items": { "$ref": "#/components/schemas/AttestationRewardOperation" } } } }, "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`). \\\nSpecify a value to get items where any of the specified fields is equal to the specified value.\n\nExample: `?anyof.sender.target=tz1WnfXMPaNTBmH7DBPwqCWs9cPDJdkGBTZ8`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of values to get items where any of the specified fields is equal to one of the specified values.\n\nExample: `?anyof.sender.target.in=tz1WnfXMPaNTBWnfXMPaNTBWnfXMPaNTBNTB,tz1SiPXX4MYGNJNDSiPXX4MYGNJNDSiPXX4M,null`.", "nullable": true, "items": { "type": "string" } }, "null": { "type": "boolean", "description": "**Is null** filter mode. \\\nUse this mode to get items where any of the specified fields is null or not.\n\nExample: `?anyof.from.to.null` or `?anyof.from.to.null=false`.", "nullable": true } }, "x-tzkt-extension": "anyof-parameter" }, "DateTimeParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=2020-01-01` is the same as `param=2020-01-01`). \\\nSpecify a datetime to get items where the specified field is equal to the specified value.\n\nExample: `?timestamp=2020-02-20T02:40:57Z`.", "format": "date-time", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify a datetime to get items where the specified field is not equal to the specified value.\n\nExample: `?timestamp.ne=2020-02-20T02:40:57Z`.", "format": "date-time", "nullable": true }, "gt": { "type": "string", "description": "**Greater than** filter mode. \\\nSpecify a datetime to get items where the specified field is greater than the specified value.\n\nExample: `?timestamp.gt=2020-02-20T02:40:57Z`.", "format": "date-time", "nullable": true }, "ge": { "type": "string", "description": "**Greater or equal** filter mode. \\\nSpecify a datetime to get items where the specified field is greater than equal to the specified value.\n\nExample: `?timestamp.ge=2020-02-20T02:40:57Z`.", "format": "date-time", "nullable": true }, "lt": { "type": "string", "description": "**Less than** filter mode. \\\nSpecify a datetime to get items where the specified field is less than the specified value.\n\nExample: `?timestamp.lt=2020-02-20T02:40:57Z`.", "format": "date-time", "nullable": true }, "le": { "type": "string", "description": "**Less or equal** filter mode. \\\nSpecify a datetime to get items where the specified field is less than or equal to the specified value.\n\nExample: `?timestamp.le=2020-02-20T02:40:57Z`.", "format": "date-time", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of datetimes to get items where the specified field is equal to one of the specified values.\n\nExample: `?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. \\\nSpecify a comma-separated list of datetimes to get items where the specified field is not equal to all the specified values.\n\nExample: `?timestamp.ni=2020-02-20,2020-02-21`.", "nullable": true, "items": { "type": "string", "format": "date-time" } } }, "x-tzkt-extension": "query-parameter" }, "Commitment": { "type": "object", "additionalProperties": false, "properties": { "address": { "type": "string", "description": "Blinded address of the account" }, "balance": { "type": "integer", "description": "Account balance to be activated", "format": "int64" }, "activated": { "type": "boolean", "description": "Flag showing whether the account has been activated or not." }, "activationLevel": { "type": "integer", "description": "Level of the block at which the account has been activated. `null` if the account is not activated yet.", "format": "int32", "nullable": true }, "activationTime": { "type": "string", "description": "Datetime of the block at which the account has been activated (ISO 8601, e.g. `2020-02-20T02:40:57Z`). `null` if the account is not activated yet.", "format": "date-time", "nullable": true }, "activatedAccount": { "description": "Info about activated account. `null` if the account is not activated yet.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] } } }, "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`). \\\nSpecify an integer number to get items where the specified field is equal to the specified value.\n\nExample: `?balance=1234`.", "format": "int32", "nullable": true }, "ne": { "type": "integer", "description": "**Not equal** filter mode. \\\nSpecify an integer number to get items where the specified field is not equal to the specified value.\n\nExample: `?balance.ne=1234`.", "format": "int32", "nullable": true }, "gt": { "type": "integer", "description": "**Greater than** filter mode. \\\nSpecify an integer number to get items where the specified field is greater than the specified value.\n\nExample: `?balance.gt=1234`.", "format": "int32", "nullable": true }, "ge": { "type": "integer", "description": "**Greater or equal** filter mode. \\\nSpecify an integer number to get items where the specified field is greater than equal to the specified value.\n\nExample: `?balance.ge=1234`.", "format": "int32", "nullable": true }, "lt": { "type": "integer", "description": "**Less than** filter mode. \\\nSpecify an integer number to get items where the specified field is less than the specified value.\n\nExample: `?balance.lt=1234`.", "format": "int32", "nullable": true }, "le": { "type": "integer", "description": "**Less or equal** filter mode. \\\nSpecify an integer number to get items where the specified field is less than or equal to the specified value.\n\nExample: `?balance.le=1234`.", "format": "int32", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of integers to get items where the specified field is equal to one of the specified values.\n\nExample: `?level.in=12,14,52,69`.", "nullable": true, "items": { "type": "integer", "format": "int32" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of integers to get items where the specified field is not equal to all the specified values.\n\nExample: `?level.ni=12,14,52,69`.", "nullable": true, "items": { "type": "integer", "format": "int32" } }, "null": { "type": "boolean", "description": "**Is null** filter mode. \\\nUse this mode to get items where the specified field is null or not.\n\nExample: `?nonce.null` or `?nonce.null=false`.", "nullable": true } }, "x-tzkt-extension": "query-parameter" }, "Constant": { "type": "object", "additionalProperties": false, "properties": { "address": { "type": "string", "description": "Global address (expression hash)" }, "value": { "description": "Constant value (either micheline, michelson or bytes, depending on the `format` parameter)" }, "size": { "type": "integer", "description": "Constant size in bytes", "format": "int32" }, "refs": { "type": "integer", "description": "Number of contracts referencing this constant", "format": "int32" }, "creator": { "description": "Account registered this constant", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "creationLevel": { "type": "integer", "description": "Level of the first block baked with this software", "format": "int32" }, "creationTime": { "type": "string", "description": "Datetime of the first block baked with this software", "format": "date-time" }, "extras": { "description": "Off-chain extras", "nullable": true } } }, "ContractTagsParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "array", "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify a comma-separated list of contract tags to get contracts with exactly the same set of tags.\nAvoid using this mode and use `.any` or `.all` instead, because it may not work as expected due to internal 'hidden' tags.\n\nExample: `?tags=fa2` or `?tags=fa1,fa12`.", "nullable": true, "items": { "type": "string" } }, "any": { "type": "array", "description": "**Has any** filter mode. \\\nSpecify a comma-separated list of contract tags to get contracts where at least one of the specified tags is presented.\n\nExample: `?tags.any=fa2` or `?tags.any=fa1,fa12`.", "nullable": true, "items": { "type": "string" } }, "all": { "type": "array", "description": "**Has all** filter mode. \\\nSpecify a comma-separated list of contract tags to get contracts where all of the specified tags are presented.\n\nExample: `?tags.all=fa2` or `?tags.all=fa1,fa12`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "fa1,fa12,fa2" }, "ContractInterface": { "type": "object", "additionalProperties": false, "properties": { "storageSchema": { "description": "JSON Schema of the contract storage in humanified format (as returned by API)", "nullable": true }, "entrypoints": { "type": "array", "description": "List of terminal entrypoints", "items": { "$ref": "#/components/schemas/EntrypointInterface" } }, "bigMaps": { "type": "array", "description": "List of currently available Big_maps", "items": { "$ref": "#/components/schemas/BigMapInterface" } }, "events": { "type": "array", "description": "List of events extractable from the code (\"static\")", "items": { "$ref": "#/components/schemas/EventInterface" } } } }, "EntrypointInterface": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Entrypoint name" }, "parameterSchema": { "description": "JSON Schema of the entrypoint parameter in humanified format (as returned by API)", "nullable": true } } }, "BigMapInterface": { "type": "object", "additionalProperties": false, "properties": { "path": { "type": "string", "description": "Full path to the Big_map in the contract storage" }, "name": { "type": "string", "description": "Big_map name, if exists (field annotation)", "nullable": true }, "keySchema": { "description": "JSON Schema of the Big_map key in humanified format (as returned by API)", "nullable": true }, "valueSchema": { "description": "JSON Schema of the Big_map value in humanified format (as returned by API)", "nullable": true } } }, "EventInterface": { "type": "object", "additionalProperties": false, "properties": { "tag": { "type": "string", "description": "Event tag" }, "eventSchema": { "description": "JSON Schema of the event type in humanified format (as returned by API)", "nullable": true } } }, "Entrypoint": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Entrypoint name" }, "jsonParameters": { "description": "A kind of JSON schema, describing how parameters will look like in a human-readable JSON format", "nullable": true }, "michelineParameters": { "description": "Parameters schema in micheline format", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IMicheline" } ] }, "michelsonParameters": { "type": "string", "description": "Parameters schema in michelson format", "nullable": true }, "unused": { "type": "boolean", "description": "Unused means that the entrypoint can be normalized to a more specific one.\nFor example here `(or %entry1 (unit %entry2) (nat %entry3))` the `%entry1` is unused entrypoint\nbecause it can be normalized to `%entry2` or `%entry3`" } } }, "ContractView": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Contract view name" }, "jsonParameterType": { "description": "Parameter type in human-readable JSON format", "nullable": true }, "jsonReturnType": { "description": "Return type in human-readable JSON format", "nullable": true }, "michelineParameterType": { "description": "Parameter type in micheline format", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IMicheline" } ] }, "michelineReturnType": { "description": "Return type in micheline format", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IMicheline" } ] }, "michelsonParameterType": { "type": "string", "description": "Parameter type in michelson format", "nullable": true }, "michelsonReturnType": { "type": "string", "description": "Return type in michelson format", "nullable": true } } }, "StorageRecord": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Id of the record that can be used for pagination", "format": "int32" }, "level": { "type": "integer", "description": "Level at which the storage value was taken", "format": "int32" }, "timestamp": { "type": "string", "description": "Timestamp at which the storage value was taken", "format": "date-time" }, "operation": { "description": "Operation that caused the storage change", "oneOf": [ { "$ref": "#/components/schemas/SourceOperation" } ] }, "value": { "description": "New storage value" } } }, "SourceOperation": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Operation type" }, "hash": { "type": "string", "description": "Operation hash", "nullable": true }, "counter": { "type": "integer", "description": "Operation counter (null in case of synthetic operations)", "format": "int32", "nullable": true }, "nonce": { "type": "integer", "description": "Operation nonce (null in case of non-internal or synthetic operations)", "format": "int32", "nullable": true }, "parameter": { "description": "Transaction parameter, including called entrypoint and value passed to the entrypoint.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TxParameter" } ] } } }, "Cycle": { "type": "object", "additionalProperties": false, "properties": { "index": { "type": "integer", "description": "Cycle index starting from zero", "format": "int32" }, "firstLevel": { "type": "integer", "description": "Level of the first block in the cycle", "format": "int32" }, "startTime": { "type": "string", "description": "Timestamp of the first block in the cycle", "format": "date-time" }, "lastLevel": { "type": "integer", "description": "Level of the last block in the cycle", "format": "int32" }, "endTime": { "type": "string", "description": "Timestamp of the last block in the cycle", "format": "date-time" }, "snapshotLevel": { "type": "integer", "description": "Height of the block where the snapshot was taken", "format": "int32" }, "randomSeed": { "type": "string", "description": "Randomly generated seed used by the network for things like baking rights distribution etc." }, "totalBakers": { "type": "integer", "description": "Total number of all active in this cycle bakers", "format": "int32" }, "totalBakingPower": { "type": "integer", "description": "Total baking power of all active in this cycle bakers", "format": "int64" }, "blockReward": { "type": "integer", "description": "Fixed reward paid to the block payload proposer in this cycle (micro tez)", "format": "int64" }, "blockBonusPerBlock": { "type": "integer", "description": "Bonus reward paid to the block producer in this cycle (micro tez)", "format": "int64" }, "attestationRewardPerBlock": { "type": "integer", "description": "Reward for attestation in this cycle (micro tez)", "format": "int64" }, "nonceRevelationReward": { "type": "integer", "description": "Reward for seed nonce revelation in this cycle (micro tez)", "format": "int64" }, "vdfRevelationReward": { "type": "integer", "description": "Reward for vdf revelation in this cycle (micro tez)", "format": "int64" }, "dalAttestationRewardPerShard": { "type": "integer", "description": "Reward for dal attestation in this cycle (micro tez)", "format": "int64" }, "quote": { "description": "Injected historical quote at the end of the cycle", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] }, "blockBonusPerSlot": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "attestationRewardPerSlot": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "endorsementRewardPerSlot": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" } } }, "AddressNullParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=` is the same as `param=`). \\\nSpecify an account address to get items where the specified field is equal to the specified value.\n\nExample: `?address=tz123..`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify an account address to get items where the specified field is not equal to the specified value.\n\nExample: `?address.ne=tz123..`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of account addresses to get items where the specified field is equal to one of the specified values.\n\nExample: `?address.in=tz123..,tz345..`.", "nullable": true, "items": { "type": "string", "nullable": true } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of account addresses to get items where the specified field is not equal to all the specified values.\n\nExample: `?address.ni=tz123..,tz345..`.", "nullable": true, "items": { "type": "string", "nullable": true } }, "null": { "type": "boolean", "description": "**Is null** filter mode. \\\nUse this mode to get items where the specified field is null or not.\n\nExample: `?address.null` or `?address.null=false`.", "nullable": true } }, "x-tzkt-extension": "query-parameter" }, "Domain": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT id. \n**[sortable]**", "format": "int32" }, "level": { "type": "integer", "description": "Domain level (i.e. tez has level=1, domain.tez has level=2, subdomain.domain.tez has level=3, etc.).", "format": "int32" }, "name": { "type": "string", "description": "Domain record name. \n**[sortable]**" }, "owner": { "description": "Owner of the domain.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "address": { "description": "Address the domain points to.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "reverse": { "type": "boolean", "description": "Whether or not the domain is on the reverse records list" }, "expiration": { "type": "string", "description": "Expiration datetime", "format": "date-time" }, "data": { "description": "Arbitrary data bound to the domain.", "nullable": true }, "firstLevel": { "type": "integer", "description": "Level of the block where the domain was first seen. \n**[sortable]**", "format": "int32" }, "firstTime": { "type": "string", "description": "Timestamp of the block where the domain was first seen.", "format": "date-time" }, "lastLevel": { "type": "integer", "description": "Level of the block where the domain was last seen. \n**[sortable]**", "format": "int32" }, "lastTime": { "type": "string", "description": "Timestamp of the block where the domain was last seen.", "format": "date-time" } } }, "ContractEvent": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT id. \n**[sortable]**", "format": "int32" }, "level": { "type": "integer", "description": "Level of the block, at which the event was emitted. \n**[sortable]**", "format": "int32" }, "timestamp": { "type": "string", "description": "Timestamp of the block, at which the event was emitted.", "format": "date-time" }, "contract": { "description": "Contract emitted the event. \nClick on the field to expand more details.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "codeHash": { "type": "integer", "description": "Hash of the contract code.", "format": "int32" }, "tag": { "type": "string", "description": "Event tag.", "nullable": true }, "payload": { "description": "Event payload in human-readable JSON format. \n**[sortable]**", "nullable": true }, "transactionId": { "type": "integer", "description": "Internal TzKT id of the transaction operation, caused the event.", "format": "int64" }, "type": { "description": "Michelson type of the payload. \n**Must be explicitly selected**", "nullable": true }, "rawPayload": { "description": "Payload in raw Micheline format. \n**Must be explicitly selected**", "nullable": true } } }, "State": { "type": "object", "additionalProperties": false, "properties": { "chain": { "type": "string", "description": "Alias name of the chain (or \"private\" if it's not on the list of known chains)" }, "chainId": { "type": "string", "description": "Unique identifier of the chain" }, "cycle": { "type": "integer", "description": "Current cycle", "format": "int32" }, "level": { "type": "integer", "description": "The height of the last block from the genesis block", "format": "int32" }, "hash": { "type": "string", "description": "Block hash" }, "protocol": { "type": "string", "description": "Current protocol hash" }, "nextProtocol": { "type": "string", "description": "Next block protocol hash" }, "timestamp": { "type": "string", "description": "The datetime at which the last block is claimed to have been created (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "votingEpoch": { "type": "integer", "description": "Current voting epoch index, starting from zero", "format": "int32" }, "votingPeriod": { "type": "integer", "description": "Current voting period index, starting from zero", "format": "int32" }, "knownLevel": { "type": "integer", "description": "The height of the last known block from the genesis block", "format": "int32" }, "lastSync": { "type": "string", "description": "The datetime of last TzKT indexer synchronization (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "synced": { "type": "boolean", "description": "State of TzKT indexer synchronization" }, "quoteLevel": { "type": "integer", "description": "The height of the block where quotes were updated last time", "format": "int32" }, "quoteBtc": { "type": "number", "description": "Last known XTZ/BTC price", "format": "double" }, "quoteEur": { "type": "number", "description": "Last known XTZ/EUR price", "format": "double" }, "quoteUsd": { "type": "number", "description": "Last known XTZ/USD price", "format": "double" }, "quoteCny": { "type": "number", "description": "Last known XTZ/CNY price", "format": "double" }, "quoteJpy": { "type": "number", "description": "Last known XTZ/JPY price", "format": "double" }, "quoteKrw": { "type": "number", "description": "Last known XTZ/KRW price", "format": "double" }, "quoteEth": { "type": "number", "description": "Last known XTZ/ETH price", "format": "double" }, "quoteGbp": { "type": "number", "description": "Last known XTZ/GBP price", "format": "double" } } }, "ProtocolParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify a protocol hash to get items where the specified field is equal to the specified value.\n\nExample: `?protocol=PsCARTHAGaz...`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify a protocol hash to get items where the specified field is not equal to the specified value.\n\nExample: `?sender.ne=PsBabyM1eUX...`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of protocol hashes to get items where the specified field is equal to one of the specified values.\n\nExample: `?sender.in=PsCARTHAGaz,PsBabyM1eUX`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of protocol hashes to get items where the specified field is not equal to all the specified values.\n\nExample: `?sender.ni=PsCARTHAGaz,PsBabyM1eUX`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter" }, "VoteParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify a value to get items where the specified field is equal to the specified value.\n\nExample: `?vote=yay`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify a value to get items where the specified field is not equal to the specified value.\n\nExample: `?vote.ne=pass`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of values to get items where the specified field is equal to one of the specified values.\n\nExample: `?vote.in=yay,nay`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of values to get items where the specified field is not equal to all the specified values.\n\nExample: `?vote.ni=yay,nay`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "yay,nay,pass" }, "DoubleConsensusKindParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify a double consensus kind to get items where the specified field is equal to the specified value.\n\nExample: `?type=double_attestation`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify a double consensus kind to get items where the specified field is not equal to the specified value.\n\nExample: `?type.ne=double_preattestation`.", "nullable": true } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "double_attestation,double_preattestation" }, "OperationStatusParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=applied` is the same as `param=applied`). \\\nSpecify an operation status to get items where the specified field is equal to the specified value.\n\nExample: `?type=failed`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify an operation status to get items where the specified field is not equal to the specified value.\n\nExample: `?type.ne=applied`.", "nullable": true } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "applied,failed,backtracked,skipped" }, "SecondaryKeyTypeParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify a secondary key type to get items where the specified field is equal to the specified value.\n\nExample: `?kind=consensus`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify a secondary key type to get items where the specified field is not equal to the specified value.\n\nExample: `?kind.ne=companion`.", "nullable": true } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "consensus,companion" }, "OpHashParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (`.eq` suffix can be omitted, i.e. `?param=...` is the same as `?param.eq=...`). \\\nSpecify an operation hash to get items where the specified field is equal to the specified value.\n\nExample: `?hash=opQRQbP...`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify an operation hash to get items where the specified field is not equal to the specified value.\n\nExample: `?hash.ne=opQRQbP...`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of operation hashes to get items where the specified field is equal to one of the specified values.\n\nExample: `?hash.in=hash1,hash2,hash3`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of operation hashes to get items where the specified field is not equal to all the specified values.\n\nExample: `?hash.ni=hash1,hash2,hash3`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter" }, "ValueTupleOfStringAndListOfInteger": { "type": "object", "additionalProperties": false }, "SmartRollupParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (`.eq` suffix can be omitted, i.e. `?param=...` is the same as `?param.eq=...`). \\\nSpecify an `sr1` address to get items where the specified field is equal to the specified value.\n\nExample: `?rollup=sr1RouasmcMAsrt4SxgGGVCBT36hzYRJBUrB`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify an `sr1` address to get items where the specified field is not equal to the specified value.\n\nExample: `?rollup.ne=sr1RouasmcMAsrt4SxgGGVCBT36hzYRJBUrB`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of `sr1` addresses to get items where the specified field is equal to one of the specified values.\n\nExample: `?rollup.in=sr1RouasmcMAsrt4SxgGGVCBT36hzYRJBUrB,sr1UsFZWCrnHH5zDfihZpSjYbc1iwLnAbEum`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of `sr1` addresses to get items where the specified field is not equal to all the specified values.\n\nExample: `?rollup.ni=sr1RouasmcMAsrt4SxgGGVCBT36hzYRJBUrB,sr1UsFZWCrnHH5zDfihZpSjYbc1iwLnAbEum`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter" }, "Src1HashParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (`.eq` suffix can be omitted, i.e. `?param=...` is the same as `?param.eq=...`). \\\nSpecify an src1-hash to get items where the specified field is equal to the specified value.\n\nExample: `?hash=src1qwe...`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify an src1-hash to get items where the specified field is not equal to the specified value.\n\nExample: `?hash.ne=src1qwe...`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of src1-hashes to get items where the specified field is equal to one of the specified values.\n\nExample: `?hash.in=hash1,hash2,hash3`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of src1-hashes to get items where the specified field is not equal to all the specified values.\n\nExample: `?hash.ni=hash1,hash2,hash3`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter" }, "RefutationMoveParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (`.eq` suffix can be omitted, i.e. `?param=...` is the same as `?param.eq=...`). \\\nSpecify a refutation game move to get items where the specified field is equal to the specified value.\n\nExample: `?move=start`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify a refutation game move to get items where the specified field is not equal to the specified value.\n\nExample: `?move.ne=start`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of refutation game moves to get items where the specified field is equal to one of the specified values.\n\nExample: `?move.in=proof,timeout`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of refutation game moves to get items where the specified field is not equal to all the specified values.\n\nExample: `?move.ni=proof,timeout`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "start,dissection,proof,timeout" }, "RefutationGameStatusParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (`.eq` suffix can be omitted, i.e. `?param=...` is the same as `?param.eq=...`). \\\nSpecify a refutation game status to get items where the specified field is equal to the specified value.\n\nExample: `?gameStatus=draw`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify a refutation game status to get items where the specified field is not equal to the specified value.\n\nExample: `?gameStatus.ne=ongoing`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of refutation game statuses to get items where the specified field is equal to one of the specified values.\n\nExample: `?gameStatus.in=loser,draw`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of refutation game statuses to get items where the specified field is not equal to all the specified values.\n\nExample: `?gameStatus.ni=loser,draw`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "none,ongoing,loser,draw" }, "StakingActionParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify a staking action to get items where the specified field is equal to the specified value.\n\nExample: `?action=stake`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify a staking action to get items where the specified field is not equal to the specified value.\n\nExample: `?action.ne=finalize`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of staking actions to get items where the specified field is equal to one of the specified values.\n\nExample: `?action.in=stake,unstake`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of staking actions to get items where the specified field is not equal to all the specified values.\n\nExample: `?action.ni=unstake,finalize`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "stake,unstake,finalize" }, "MigrationKindParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify a migration kind to get items where the specified field is equal to the specified value.\n\nExample: `?kind=bootstrap`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify a migration kind to get items where the specified field is not equal to the specified value.\n\nExample: `?type.ne=proposal_invoice`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of migration kinds to get items where the specified field is equal to one of the specified values.\n\nExample: `?sender.in=bootstrap,proposal_invoice`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of migration kinds to get items where the specified field is not equal to all the specified values.\n\nExample: `?sender.ni=airdrop,bootstrap`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "bootstrap,activate_delegate,airdrop,proposal_invoice,code_change,origination,subsidy,remove_bigmap_key" }, "Protocol": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "integer", "description": "Protocol code, representing a number of protocol changes since genesis (mod 256, but `-1` for the genesis block)", "format": "int32" }, "hash": { "type": "string", "description": "Hash of the protocol" }, "version": { "type": "integer", "description": "Global version number", "format": "int32" }, "firstLevel": { "type": "integer", "description": "Block height where the protocol was applied", "format": "int32" }, "firstCycle": { "type": "integer", "description": "Index of the first cycle started with the protocol", "format": "int32" }, "firstCycleLevel": { "type": "integer", "description": "Level of the first block of the first cycle started with the protocol", "format": "int32" }, "lastLevel": { "type": "integer", "description": "Block height where the protocol ends. `null` if the protocol is active", "format": "int32", "nullable": true }, "constants": { "description": "Information about the protocol constants", "oneOf": [ { "$ref": "#/components/schemas/ProtocolConstants" } ] }, "extras": { "description": "Off-chain extras", "nullable": true } } }, "ProtocolConstants": { "type": "object", "additionalProperties": false, "properties": { "rampUpCycles": { "type": "integer", "description": "The number of cycles where security deposit is ramping up", "format": "int32" }, "noRewardCycles": { "type": "integer", "description": "The number of cycles with no baking rewards", "format": "int32" }, "consensusRightsDelay": { "type": "integer", "description": "Delay in cycles after which baking rights are assigned", "format": "int32" }, "delegateParametersActivationDelay": { "type": "integer", "description": "Delay in cycles after which the parameters from `set_delegate_parameters` operations take effect", "format": "int32" }, "blocksPerCycle": { "type": "integer", "description": "A number of blocks the cycle contains", "format": "int32" }, "blocksPerCommitment": { "type": "integer", "description": "A number of blocks that indicates how often seed nonce hash is included in a block. Seed nonce hash presents in only one out of `blocksPerCommitment`", "format": "int32" }, "blocksPerSnapshot": { "type": "integer", "description": "A number of blocks that indicates how often a snapshot (snapshots are records of the state of stake distributions) is taken", "format": "int32" }, "blocksPerVoting": { "type": "integer", "description": "A number of block that indicates how long a voting period takes", "format": "int32" }, "timeBetweenBlocks": { "type": "integer", "description": "Minimum amount of seconds between blocks", "format": "int32" }, "attestersPerBlock": { "type": "integer", "description": "Number of bakers that assigned to attest a block", "format": "int32" }, "hardOperationGasLimit": { "type": "integer", "description": "Maximum amount of gas that one operation can consume", "format": "int32" }, "hardOperationStorageLimit": { "type": "integer", "description": "Maximum amount of storage that one operation can consume", "format": "int32" }, "hardBlockGasLimit": { "type": "integer", "description": "Maximum amount of total gas usage of a single block", "format": "int32" }, "minimalStake": { "type": "integer", "description": "Required number of tokens to get 1 roll (micro tez)", "format": "int64" }, "minimalFrozenStake": { "type": "integer", "description": "Required number of tokens to be frozen by bakers (micro tez)", "format": "int64" }, "blockDeposit": { "type": "integer", "description": "Security deposit for baking (producing) a block (micro tez)", "format": "int64" }, "blockReward": { "type": "array", "description": "Reward for baking (producing) a block (micro tez)", "items": { "type": "integer", "format": "int64" } }, "attestationDeposit": { "type": "integer", "description": "Security deposit for sending an attestation operation (micro tez)", "format": "int64" }, "attestationReward": { "type": "array", "description": "Reward for sending an attestation operation (micro tez)", "items": { "type": "integer", "format": "int64" } }, "originationSize": { "type": "integer", "description": "Initial storage size of an originated (created) account (bytes)", "format": "int32" }, "byteCost": { "type": "integer", "description": "Cost of one storage byte in the blockchain (micro tez)", "format": "int32" }, "proposalQuorum": { "type": "number", "description": "Percentage of the total number of voting power required to select a proposal on the proposal period", "format": "double" }, "ballotQuorumMin": { "type": "number", "description": "The minimum value of quorum percentage on the exploration and promotion periods", "format": "double" }, "ballotQuorumMax": { "type": "number", "description": "The maximum value of quorum percentage on the exploration and promotion periods", "format": "double" }, "lbToggleThreshold": { "type": "integer", "description": "1/2 window size of 2000 blocks with precision of 1000000 for integer computation", "format": "int32" }, "consensusThreshold": { "type": "integer", "description": "Attestation quorum", "format": "int32" }, "minParticipationNumerator": { "type": "integer", "description": "Number of attested slots needed to receive attestation rewards", "format": "int32" }, "minParticipationDenominator": { "type": "integer", "description": "Number of attested slots needed to receive attestation rewards", "format": "int32" }, "denunciationPeriod": { "type": "integer", "description": "Number of cycles after double baking/(pre)attestation where an accusation operation can be injected", "format": "int32" }, "slashingDelay": { "type": "integer", "description": "Number of cycles after double baking/(pre)attestation evidence where slashing happens", "format": "int32" }, "maxDelegatedOverFrozenRatio": { "type": "integer", "description": "The ratio of delegated tez over the baker’s frozen stake", "format": "int32" }, "maxExternalOverOwnStakeRatio": { "type": "integer", "description": "The ratio of external staked balance over the baker’s own staked balance", "format": "int32" }, "delegationPowerDivider": { "type": "integer", "description": "The divider by which delegation power is divided", "format": "int32" }, "smartRollupOriginationSize": { "type": "integer", "description": "Initial storage size of an originated (created) smart rollup (bytes)", "format": "int32" }, "smartRollupStakeAmount": { "type": "integer", "description": "Smart rollup commitment bond (mutez)", "format": "int64" }, "smartRollupChallengeWindow": { "type": "integer", "description": "Window (in blocks) when it's possible to refute pending commitment", "format": "int32" }, "smartRollupCommitmentPeriod": { "type": "integer", "description": "Period (in blocks) for publishing commitments", "format": "int32" }, "smartRollupTimeoutPeriod": { "type": "integer", "description": "Period (in blocks) when a refutation game player must make a turn", "format": "int32" }, "dalNumberOfShards": { "type": "integer", "description": "Number of DAL Shards", "format": "int32" }, "dictator": { "type": "string", "description": "Governance dictator", "nullable": true }, "endorsersPerBlock": { "type": "integer", "description": "**DEPRECATED**", "format": "int32" }, "endorsementDeposit": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "endorsementReward": { "type": "array", "description": "**DEPRECATED**", "items": { "type": "integer", "format": "int64" } } } }, "Quote": { "type": "object", "additionalProperties": false, "properties": { "level": { "type": "integer", "description": "The level of the block at which the quote has been saved", "format": "int32" }, "timestamp": { "type": "string", "description": "The datetime at which the quote has been saved (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "btc": { "type": "number", "description": "XTZ/BTC price", "format": "double" }, "eur": { "type": "number", "description": "XTZ/EUR price", "format": "double" }, "usd": { "type": "number", "description": "XTZ/USD price", "format": "double" }, "cny": { "type": "number", "description": "XTZ/CNY price", "format": "double" }, "jpy": { "type": "number", "description": "XTZ/JPY price", "format": "double" }, "krw": { "type": "number", "description": "XTZ/KRW price", "format": "double" }, "eth": { "type": "number", "description": "XTZ/ETH price", "format": "double" }, "gbp": { "type": "number", "description": "XTZ/GBP price", "format": "double" } } }, "BakerRewards": { "type": "object", "additionalProperties": false, "properties": { "cycle": { "type": "integer", "description": "Cycle in which rewards were or will be earned. \n**[sortable]**", "format": "int32" }, "ownDelegatedBalance": { "type": "integer", "description": "Amount delegated from the baker's own balance (micro tez).\nThis amount doesn't include staked amount.", "format": "int64" }, "externalDelegatedBalance": { "type": "integer", "description": "Amount delegated from external delegators and \"unstakers\" (delegators who left the baker, but still had locked unstaked balance delegated to the baker) (micro tez).\nThis amount doesn't include external staked amount.", "format": "int64" }, "delegatorsCount": { "type": "integer", "description": "Number of delegators (those who were delegated to the baker).\nThis doesn't include \"unstakers\" (delegators who left the baker, but still had locked unstaked balance delegated to the baker).", "format": "int32" }, "ownStakedBalance": { "type": "integer", "description": "Amount staked from the baker's own balance (micro tez).", "format": "int64" }, "externalStakedBalance": { "type": "integer", "description": "Amount staked from external stakers (micro tez).", "format": "int64" }, "stakersCount": { "type": "integer", "description": "Number of external stakers (those who delegated to the baker and also staked some amount).", "format": "int32" }, "issuedPseudotokens": { "type": "string", "description": "Amount of staking pseudotokens issued by/for external stakers.", "nullable": true }, "bakingPower": { "type": "integer", "description": "Baker's baking power", "format": "int64" }, "totalBakingPower": { "type": "integer", "description": "Sum of baking power of all active bakers", "format": "int64" }, "expectedBlocks": { "type": "number", "description": "Expected value of how many blocks baker should produce based on baker's active stake, selected stake and blocks per cycle.", "format": "double" }, "futureBlocks": { "type": "integer", "description": "Number of blocks which baker is allowed to produce in this cycle based on future baking rights.", "format": "int32" }, "futureBlockRewards": { "type": "integer", "description": "Estimated value of future block rewards.", "format": "int64" }, "blocks": { "type": "integer", "description": "Number of successfully baked blocks (both proposed and re-proposed blocks).", "format": "int32" }, "blockRewardsDelegated": { "type": "integer", "description": "Rewards, corresponding to delegated stake, received for baked blocks (both proposed and re-proposed blocks) on baker's liquid balance\n(it is not frozen and can be spent immediately).", "format": "int64" }, "blockRewardsStakedOwn": { "type": "integer", "description": "Rewards, corresponding to baker's own stake, received for baked blocks (both proposed and re-proposed blocks) on baker's own staked balance\n(it is frozen and belongs to the baker).", "format": "int64" }, "blockRewardsStakedEdge": { "type": "integer", "description": "Rewards, corresponding to baker's edge from external stake, received for baked blocks (both proposed and re-proposed blocks) on baker's own staked balance\n(it is frozen and belongs to the baker).", "format": "int64" }, "blockRewardsStakedShared": { "type": "integer", "description": "Rewards, corresponding to baker's external stake, received for baked blocks (both proposed and re-proposed blocks) on baker's external staked balance\n(it is frozen and belongs to baker's stakers).", "format": "int64" }, "missedBlocks": { "type": "integer", "description": "Number of missed opportunities to bake block.", "format": "int32" }, "missedBlockRewards": { "type": "integer", "description": "Rewards which were not received due to missing blocks.", "format": "int64" }, "expectedAttestations": { "type": "number", "description": "Expected value of how many slots baker should validate based on baker's active stake, selected stake and attestation slots per cycle.", "format": "double" }, "futureAttestations": { "type": "integer", "description": "Number of slots which baker is allowed to validate in this cycle based on future attestation rights.", "format": "int32" }, "futureAttestationRewards": { "type": "integer", "description": "Estimated value of future attestation rewards.", "format": "int64" }, "attestations": { "type": "integer", "description": "Number of successfully attested slots.", "format": "int32" }, "attestationRewardsDelegated": { "type": "integer", "description": "Rewards, corresponding to delegated stake, received for attested slots on baker's liquid balance\n(it is not frozen and can be spent immediately).", "format": "int64" }, "attestationRewardsStakedOwn": { "type": "integer", "description": "Rewards, corresponding to baker's own stake, received for attested slots on baker's own staked balance\n(it is frozen and belongs to the baker).", "format": "int64" }, "attestationRewardsStakedEdge": { "type": "integer", "description": "Rewards, corresponding to baker's edge from external stake, received for attested slots on baker's own staked balance\n(it is frozen and belongs to the baker).", "format": "int64" }, "attestationRewardsStakedShared": { "type": "integer", "description": "Rewards, corresponding to baker's external stake, received for attested slots on baker's external staked balance\n(it is frozen and belongs to baker's stakers).", "format": "int64" }, "missedAttestations": { "type": "integer", "description": "Number of not attested (missed) slots.", "format": "int32" }, "missedAttestationRewards": { "type": "integer", "description": "Rewards which were not received due to missing attestations.", "format": "int64" }, "expectedDalAttestations": { "type": "integer", "description": "Expected value of how many dal shards baker should attest based on baker's active stake, selected stake and total shards per cycle.", "format": "int64" }, "futureDalAttestationRewards": { "type": "integer", "description": "Estimated value of future dal attestation rewards.", "format": "int64" }, "dalAttestationRewardsDelegated": { "type": "integer", "description": "Rewards, corresponding to delegated stake, received for attested dal shards on baker's liquid balance\n(it is not frozen and can be spent immediately).", "format": "int64" }, "dalAttestationRewardsStakedOwn": { "type": "integer", "description": "Rewards, corresponding to baker's own stake, received for attested dal shards on baker's own staked balance\n(it is frozen and belongs to the baker).", "format": "int64" }, "dalAttestationRewardsStakedEdge": { "type": "integer", "description": "Rewards, corresponding to baker's edge from external stake, received for attested dal shards on baker's own staked balance\n(it is frozen and belongs to the baker).", "format": "int64" }, "dalAttestationRewardsStakedShared": { "type": "integer", "description": "Rewards, corresponding to baker's external stake, received for attested dal shards on baker's external staked balance\n(it is frozen and belongs to baker's stakers).", "format": "int64" }, "missedDalAttestationRewards": { "type": "integer", "description": "Rewards which were not received due to denunciation or not enough participation.", "format": "int64" }, "blockFees": { "type": "integer", "description": "Operation fees which were harvested from successfully baked blocks.", "format": "int64" }, "missedBlockFees": { "type": "integer", "description": "Operation fees which were not received due to missing blocks.", "format": "int64" }, "doubleBakingRewards": { "type": "integer", "description": "Rewards for detecting double baking (accusing someone of producing two different blocks at the same level).", "format": "int64" }, "doubleBakingLostStaked": { "type": "integer", "description": "Amount of baker's own staked balance lost due to double baking", "format": "int64" }, "doubleBakingLostUnstaked": { "type": "integer", "description": "Amount of baker's own unstaked balance lost due to double baking", "format": "int64" }, "doubleBakingLostExternalStaked": { "type": "integer", "description": "Amount of baker's external staked balance lost due to double baking", "format": "int64" }, "doubleBakingLostExternalUnstaked": { "type": "integer", "description": "Amount of baker's external unstaked balance lost due to double baking", "format": "int64" }, "doubleConsensusRewards": { "type": "integer", "description": "Rewards for detecting double (pre)attestation (accusing someone of validating two different blocks at the same level).", "format": "int64" }, "doubleConsensusLostStaked": { "type": "integer", "description": "Amount of baker's own staked balance lost due to double (pre)attestation", "format": "int64" }, "doubleConsensusLostUnstaked": { "type": "integer", "description": "Amount of baker's own unstaked balance lost due to double (pre)attestation", "format": "int64" }, "doubleConsensusLostExternalStaked": { "type": "integer", "description": "Amount of baker's external staked balance lost due to double (pre)attestation", "format": "int64" }, "doubleConsensusLostExternalUnstaked": { "type": "integer", "description": "Amount of baker's external unstaked balance lost due to double (pre)attestation", "format": "int64" }, "vdfRevelationRewardsDelegated": { "type": "integer", "description": "Rewards, corresponding to delegated stake, for including vdf revelations, received on baker's liquid balance\n(it is not frozen and can be spent immediately).", "format": "int64" }, "vdfRevelationRewardsStakedOwn": { "type": "integer", "description": "Rewards, corresponding to baker's own stake, for including vdf revelations, received on baker's own staked balance\n(it is frozen and belongs to the baker).", "format": "int64" }, "vdfRevelationRewardsStakedEdge": { "type": "integer", "description": "Rewards, corresponding to baker's edge from external stake, for including vdf revelations, received on baker's own staked balance\n(it is frozen and belongs to the baker).", "format": "int64" }, "vdfRevelationRewardsStakedShared": { "type": "integer", "description": "Rewards, corresponding to baker's external stake, for including vdf revelations, received on baker's external staked balance\n(it is frozen and belongs to baker's stakers).", "format": "int64" }, "nonceRevelationRewardsDelegated": { "type": "integer", "description": "Rewards, corresponding to delegated stake, for including seed nonce revelations, received on baker's liquid balance\n(it is not frozen and can be spent immediately).", "format": "int64" }, "nonceRevelationRewardsStakedOwn": { "type": "integer", "description": "Rewards, corresponding to baker's own stake, for including seed nonce revelations, received on baker's own staked balance\n(it is frozen and belongs to the baker).", "format": "int64" }, "nonceRevelationRewardsStakedEdge": { "type": "integer", "description": "Rewards, corresponding to baker's edge from external stake, for including seed nonce revelations, received on baker's own staked balance\n(it is frozen and belongs to the baker).", "format": "int64" }, "nonceRevelationRewardsStakedShared": { "type": "integer", "description": "Rewards, corresponding to baker's external stake, for including seed nonce revelations, received on baker's external staked balance\n(it is frozen and belongs to baker's stakers).", "format": "int64" }, "nonceRevelationLosses": { "type": "integer", "description": "Amount of frozen deposits lost due to missing seed nonce revelation (always zero after Ithaca).", "format": "int64" }, "quote": { "description": "Injected historical quote at the end of the cycle", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] }, "expectedDalShards": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "expectedEndorsements": { "type": "number", "description": "**DEPRECATED**", "format": "double" }, "futureEndorsements": { "type": "integer", "description": "**DEPRECATED**", "format": "int32" }, "futureEndorsementRewards": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "endorsements": { "type": "integer", "description": "**DEPRECATED**", "format": "int32" }, "endorsementRewardsDelegated": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "endorsementRewardsStakedOwn": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "endorsementRewardsStakedEdge": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "endorsementRewardsStakedShared": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "missedEndorsements": { "type": "integer", "description": "**DEPRECATED**", "format": "int32" }, "missedEndorsementRewards": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doubleEndorsingRewards": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doubleEndorsingLostStaked": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doubleEndorsingLostUnstaked": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doubleEndorsingLostExternalStaked": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doubleEndorsingLostExternalUnstaked": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doublePreendorsingRewards": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doublePreendorsingLostStaked": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doublePreendorsingLostUnstaked": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doublePreendorsingLostExternalStaked": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doublePreendorsingLostExternalUnstaked": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" } } }, "DelegatorRewards": { "type": "object", "additionalProperties": false, "properties": { "cycle": { "type": "integer", "description": "Cycle in which rewards were or will be earned. \n**[sortable]**", "format": "int32" }, "baker": { "description": "Baker at the snapshot time.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "delegatedBalance": { "type": "integer", "description": "Amount delegated to the baker at the snapshot time (micro tez).\nThis amount doesn't include staked amount.", "format": "int64" }, "stakedPseudotokens": { "type": "string", "description": "Amount of staked pseudotokens, representing staker's share within the baker's `externalStakedBalance` at the snapshot time.", "nullable": true }, "stakedBalance": { "type": "integer", "description": "Estimated amount staked to the baker at the snapshot time (micro tez).\nIt's computed on-the-fly as `externalStakedBalance * stakedPseudotokens / issuedPseudotokens`.", "format": "int64", "nullable": true }, "bakerRewards": { "description": "Rewards of the delegator's baker, from which the delegator can estimate his share, given his `delegatedBalance`.", "oneOf": [ { "$ref": "#/components/schemas/BakerRewards" } ] }, "quote": { "description": "Injected historical quote at the end of the cycle", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] }, "bakingPower": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "totalBakingPower": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "bakerDelegatedBalance": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "externalDelegatedBalance": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "bakerStakedBalance": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "externalStakedBalance": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "expectedBlocks": { "type": "number", "description": "**DEPRECATED**", "format": "double" }, "expectedEndorsements": { "type": "number", "description": "**DEPRECATED**", "format": "double" }, "expectedDalShards": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "futureBlocks": { "type": "integer", "description": "**DEPRECATED**", "format": "int32" }, "futureBlockRewards": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "blocks": { "type": "integer", "description": "**DEPRECATED**", "format": "int32" }, "blockRewardsDelegated": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "blockRewardsStakedOwn": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "blockRewardsStakedEdge": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "blockRewardsStakedShared": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "missedBlocks": { "type": "integer", "description": "**DEPRECATED**", "format": "int32" }, "missedBlockRewards": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "futureEndorsements": { "type": "integer", "description": "**DEPRECATED**", "format": "int32" }, "futureEndorsementRewards": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "endorsements": { "type": "integer", "description": "**DEPRECATED**", "format": "int32" }, "endorsementRewardsDelegated": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "endorsementRewardsStakedOwn": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "endorsementRewardsStakedEdge": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "endorsementRewardsStakedShared": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "missedEndorsements": { "type": "integer", "description": "**DEPRECATED**", "format": "int32" }, "missedEndorsementRewards": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "futureDalAttestationRewards": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "dalAttestationRewardsDelegated": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "dalAttestationRewardsStakedOwn": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "dalAttestationRewardsStakedEdge": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "dalAttestationRewardsStakedShared": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "missedDalAttestationRewards": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "blockFees": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "missedBlockFees": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doubleBakingRewards": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doubleBakingLostStaked": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doubleBakingLostUnstaked": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doubleBakingLostExternalStaked": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doubleBakingLostExternalUnstaked": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doubleEndorsingRewards": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doubleEndorsingLostStaked": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doubleEndorsingLostUnstaked": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doubleEndorsingLostExternalStaked": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doubleEndorsingLostExternalUnstaked": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doublePreendorsingRewards": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doublePreendorsingLostStaked": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doublePreendorsingLostUnstaked": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doublePreendorsingLostExternalStaked": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "doublePreendorsingLostExternalUnstaked": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "vdfRevelationRewardsDelegated": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "vdfRevelationRewardsStakedOwn": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "vdfRevelationRewardsStakedEdge": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "vdfRevelationRewardsStakedShared": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "nonceRevelationRewardsDelegated": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "nonceRevelationRewardsStakedOwn": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "nonceRevelationRewardsStakedEdge": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "nonceRevelationRewardsStakedShared": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" }, "nonceRevelationLosses": { "type": "integer", "description": "**DEPRECATED**", "format": "int64" } } }, "StakerRewards": { "type": "object", "additionalProperties": false, "properties": { "cycle": { "type": "integer", "description": "Cycle in which the rewards were earned. \n**[sortable]**", "format": "int32" }, "baker": { "description": "Staker's baker.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "initialStake": { "type": "integer", "description": "Staked balance at the beginning of the cycle (micro tez).", "format": "int64" }, "addedStake": { "type": "integer", "description": "Amount added (staked) during the cycle (micro tez).", "format": "int64" }, "removedStake": { "type": "integer", "description": "Amount removed (unstaked) during the cycle (micro tez).", "format": "int64" }, "finalStake": { "type": "integer", "description": "Staked balance at the end of the cycle (micro tez).", "format": "int64" }, "avgStake": { "type": "integer", "description": "Average (per-block) staked balance (micro tez).", "format": "int64" }, "rewards": { "type": "integer", "description": "Staking rewards (or losses if negative) earned during the cycle (micro tez).", "format": "int64" }, "bakerRewards": { "description": "Rewards of the staker's baker, from which the staker can understand the source of the rewards/losses.", "oneOf": [ { "$ref": "#/components/schemas/BakerRewards" } ] }, "quote": { "description": "Injected historical quote at the end of the cycle", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } }, "RewardSplit": { "allOf": [ { "$ref": "#/components/schemas/BakerRewards" }, { "type": "object", "additionalProperties": false, "properties": { "delegators": { "type": "array", "description": "List of delegators, forming baker's baking power.\nThis list includes \"unstakers\" (delegators who left the baker, but still had locked unstaked balance delegated to the baker),\ntherefore its length shouldn't necessarily match the `delegatorsCount` value.", "items": { "$ref": "#/components/schemas/SplitDelegator" } }, "stakers": { "type": "array", "description": "List of stakers, forming baker's baking power.", "items": { "$ref": "#/components/schemas/SplitStaker" } }, "actualStakers": { "type": "array", "description": "List of actual stakers, receiving staking rewards regardless of contribution to the baker's baking power.", "items": { "$ref": "#/components/schemas/SplitActualStaker" } } } } ] }, "SplitDelegator": { "type": "object", "additionalProperties": false, "properties": { "address": { "type": "string", "description": "Address of the delegator" }, "delegatedBalance": { "type": "integer", "description": "Amount delegated to the baker at the snapshot time (micro tez).\nThis amount doesn't include staked amount.", "format": "int64" }, "emptied": { "type": "boolean", "description": "Indicates whether the delegator is emptied (at the moment, not at the snapshot time).\nEmptied accounts (users with zero balance) should be re-allocated, so if you make payment to the emptied account you will pay allocation fee." } } }, "SplitStaker": { "type": "object", "additionalProperties": false, "properties": { "address": { "type": "string", "description": "Address of the staker" }, "stakedPseudotokens": { "type": "string", "description": "Amount of staked pseudotokens at the snapshot time, representing staker's share within the baker's `externalStakedBalance`.", "nullable": true }, "stakedBalance": { "type": "integer", "description": "Estimated amount staked to the baker at the snapshot time (micro tez).\nIt's computed on-the-fly as `externalStakedBalance * stakedPseudotokens / issuedPseudotokens`.", "format": "int64" } } }, "SplitActualStaker": { "type": "object", "additionalProperties": false, "properties": { "address": { "type": "string", "description": "Address of the delegator" }, "initialStake": { "type": "integer", "description": "Staked balance at the beginning of the cycle (micro tez).", "format": "int64" }, "finalStake": { "type": "integer", "description": "Staked balance at the end of the cycle (micro tez).", "format": "int64" }, "rewards": { "type": "integer", "description": "Staking rewards (or losses if negative) earned during the cycle (micro tez).", "format": "int64" } } }, "SplitMember": { "type": "object", "additionalProperties": false, "properties": { "address": { "type": "string", "description": "Address of the delegator" }, "delegatedBalance": { "type": "integer", "description": "Amount delegated to the baker at the snapshot time (micro tez).\nThis amount doesn't include staked amount.", "format": "int64" }, "stakedPseudotokens": { "type": "string", "description": "Amount of staked pseudotokens at the snapshot time, representing staker's share within the baker's `externalStakedBalance`.", "nullable": true }, "stakedBalance": { "type": "integer", "description": "Estimated amount staked to the baker at the snapshot time (micro tez).\nIt's computed on-the-fly as `externalStakedBalance * stakedPseudotokens / issuedPseudotokens`.", "format": "int64" }, "emptied": { "type": "boolean", "description": "Indicates whether the delegator is emptied (at the moment, not at the snapshot time).\nEmptied accounts (users with zero balance) should be re-allocated, so if you make payment to the emptied account you will pay allocation fee." } } }, "BakingRightTypeParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify baking right type to get items where the specified field is equal to the specified value.\n\nExample: `?type=baking`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify baking right type to get items where the specified field is not equal to the specified value.\n\nExample: `?type.ne=attestation`.", "nullable": true } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "baking,attestation" }, "BakingRightStatusParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify baking right status to get items where the specified field is equal to the specified value.\n\nExample: `?type=future`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify baking right status to get items where the specified field is not equal to the specified value.\n\nExample: `?type.ne=missed`.", "nullable": true } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "future,realized,uncovered,missed" }, "BakingRight": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Type of the right:\n- `baking` - right to bake (produce) a block;\n- `attestation` - right to attest (validate) a block." }, "cycle": { "type": "integer", "description": "Cycle on which the right can be realized.", "format": "int32" }, "level": { "type": "integer", "description": "Level at which a block must be baked or an attestation must be sent.", "format": "int32" }, "timestamp": { "type": "string", "description": "Time (estimated, in case of future rights) when a block must be baked or an attestation must be sent.", "format": "date-time" }, "round": { "type": "integer", "description": "Round (0 - ∞) at which the baker can propose/produce a block.\nIf a baker at round `0` doesn't produce a block within the given time interval, then the right goes to a baker at round` 1`, etc.\nFor `attestation` rights this field is always `null`.", "format": "int32", "nullable": true }, "slots": { "type": "integer", "description": "Number of slots to be attested. For `baking` rights this field is always `null`.", "format": "int32", "nullable": true }, "baker": { "description": "Baker to which baking or attestation right has been given.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "status": { "type": "string", "description": "Status of the baking or attestation right:\n- `future` - the right is not realized yet;\n- `realized` - the right was successfully realized;\n- `missed` - the right was not realized." } } }, "SrStaker": { "allOf": [ { "$ref": "#/components/schemas/Alias" }, { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT id. \n**[sortable]**", "format": "int32" }, "bondStatus": { "type": "string", "description": "Bond status (`active`, `returned`, or `lost`)." }, "bondLevel": { "type": "integer", "description": "Level of the block where the staker published his first commitment. \n**[sortable]**", "format": "int32" }, "bondTime": { "type": "string", "description": "Timestamp of the block where the staker published his first commitment.", "format": "date-time" } } } ] }, "SrBondStatusParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (`.eq` suffix can be omitted, i.e. `?param=...` is the same as `?param.eq=...`). \\\nSpecify an sr bond status to get items where the specified field is equal to the specified value.\n\nExample: `?status=active`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify an sr bond status to get items where the specified field is not equal to the specified value.\n\nExample: `?status.ne=active`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of sr bond statuses to get items where the specified field is equal to one of the specified values.\n\nExample: `?status.in=returned,lost`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of sr bond statuses to get items where the specified field is not equal to all the specified values.\n\nExample: `?status.ni=returned,lost`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "active,returned,lost" }, "SrCommitmentStatusParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (`.eq` suffix can be omitted, i.e. `?param=...` is the same as `?param.eq=...`). \\\nSpecify an sr commitment status to get items where the specified field is equal to the specified value.\n\nExample: `?status=pending`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify an sr commitment status to get items where the specified field is not equal to the specified value.\n\nExample: `?status.ne=cemented`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of sr commitment statuses to get items where the specified field is equal to one of the specified values.\n\nExample: `?status.in=cemented,executed`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of sr commitment statuses to get items where the specified field is not equal to all the specified values.\n\nExample: `?status.ni=cemented,executed`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "orphan,refuted,pending,cemented,executed" }, "SrCommitment": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT id. \n**[sortable]**", "format": "int64" }, "rollup": { "description": "Smart rollup.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "initiator": { "description": "Account that published the commitment first.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "inboxLevel": { "type": "integer", "description": "Inbox level. \n**[sortable]**", "format": "int32" }, "state": { "type": "string", "description": "State hash." }, "hash": { "type": "string", "description": "Commitment hash." }, "ticks": { "type": "integer", "description": "Number of ticks.", "format": "int64" }, "firstLevel": { "type": "integer", "description": "Level of the block where the commitment was first published. \n**[sortable]**", "format": "int32" }, "firstTime": { "type": "string", "description": "Timestamp of the block where the commitment was first published.", "format": "date-time" }, "lastLevel": { "type": "integer", "description": "Level of the block where the commitment was last updated. \n**[sortable]**", "format": "int32" }, "lastTime": { "type": "string", "description": "Timestamp of the block where the commitment was last updated.", "format": "date-time" }, "stakers": { "type": "integer", "description": "Number of stakers, published this commitment. \n**[sortable]**", "format": "int32" }, "activeStakers": { "type": "integer", "description": "Number of active (not refuted) stakers. \n**[sortable]**", "format": "int32" }, "successors": { "type": "integer", "description": "Number of successor commitments. \n**[sortable]**", "format": "int32" }, "status": { "type": "string", "description": "Commitment status (`pending`, `cemented`, `executed`, `refuted`, or `orphan`)." }, "predecessor": { "description": "Predecessor commitment.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SrCommitmentInfo" } ] } } }, "SrGame": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT id. \n**[sortable]**", "format": "int64" }, "rollup": { "description": "Smart rollup, in which's scope the refutation game was started.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "initiator": { "description": "Initiator, who found a wrong commitment and started the refutation game.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "initiatorCommitment": { "description": "Initiator's version of a valid commitment", "oneOf": [ { "$ref": "#/components/schemas/SrCommitmentInfo" } ] }, "opponent": { "description": "Opponent, who was accused in publishing a wrong commitment.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "opponentCommitment": { "description": "Opponent's version of a valid commitment", "oneOf": [ { "$ref": "#/components/schemas/SrCommitmentInfo" } ] }, "lastMove": { "description": "The most recent move (`sr_refute` operation).", "oneOf": [ { "$ref": "#/components/schemas/SrGameMove" } ] }, "firstLevel": { "type": "integer", "description": "Level of the block where the refutation game was started. \n**[sortable]**", "format": "int32" }, "firstTime": { "type": "string", "description": "Timestamp of the block where the refutation game was started.", "format": "date-time" }, "lastLevel": { "type": "integer", "description": "Level of the block where the refutation game was last updated. \n**[sortable]**", "format": "int32" }, "lastTime": { "type": "string", "description": "Timestamp of the block where the refutation game was last updated.", "format": "date-time" }, "initiatorReward": { "type": "integer", "description": "In case the initiator won, this field will contain the reward amount (in mutez).", "format": "int64", "nullable": true }, "initiatorLoss": { "type": "integer", "description": "In case the initiator lost (including a `draw`), this field will contain the loss amount (in mutez).", "format": "int64", "nullable": true }, "opponentReward": { "type": "integer", "description": "In case the opponent won, this field will contain the reward amount (in mutez).", "format": "int64", "nullable": true }, "opponentLoss": { "type": "integer", "description": "In case the opponent lost (including a `draw`), this field will contain the loss amount (in mutez).", "format": "int64", "nullable": true } } }, "SrGameMove": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Unique ID of the operation, stored in the TzKT indexer database.", "format": "int64" }, "level": { "type": "integer", "description": "The height of the block from the genesis block, in which the operation was included.", "format": "int32" }, "timestamp": { "type": "string", "description": "Datetime of the block, in which the operation was included (ISO 8601, e.g. `2020-02-20T02:40:57Z`).", "format": "date-time" }, "sender": { "description": "Information about the account who has sent the operation.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "move": { "type": "string", "description": "Player's move (`start`, `dissection`, `proof`, `timeout`)." }, "gameStatus": { "type": "string", "description": "Game status after the move\n(`ongoing` - game in progress, `loser` - one of the players lost, `draw` - both players lost)." } } }, "SrMessageTypeParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (`.eq` suffix can be omitted, i.e. `?param=...` is the same as `?param.eq=...`). \\\nSpecify an inbox message type to get items where the specified field is equal to the specified value.\n\nExample: `?status=external`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify an inbox message type to get items where the specified field is not equal to the specified value.\n\nExample: `?status.ne=transfer`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of inbox message types to get items where the specified field is equal to one of the specified values.\n\nExample: `?status.in=transfer,external`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of inbox message types to get items where the specified field is not equal to all the specified values.\n\nExample: `?status.ni=transfer,external`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "level_start,level_info,level_end,transfer,external,migration" }, "SrMessage": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT id. \n**[sortable]**", "format": "int64" }, "level": { "type": "integer", "description": "Level of the block where the message was pushed. \n**[sortable]**", "format": "int32" }, "index": { "type": "integer", "description": "Index of the inbox message within the block. ", "format": "int32" }, "timestamp": { "type": "string", "description": "Timestamp of the block where the message was pushed.", "format": "date-time" }, "type": { "type": "string", "description": "Type of the message (`level_start`, `level_info`, `level_end`, `transfer`, `external`, `migration`)." }, "predecessorHash": { "type": "string", "description": "For `level_info` messages only. Hash of the predecessor block.", "nullable": true }, "predecessorTimestamp": { "type": "string", "description": "For `level_info` messages only. Timestamp of the predecessor block.", "format": "date-time", "nullable": true }, "initiator": { "description": "For `transfer` messages only. Account, initiated the operation.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "sender": { "description": "For `transfer` messages only. Smart contract, sent the internal transaction.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "target": { "description": "For `transfer` messages only. Smart rollup to which the internal transaction was sent.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "entrypoint": { "type": "string", "description": "For `transfer` messages only. Entrypoint called in the target rollup", "nullable": true }, "parameter": { "description": "For `transfer` messages only. Value passed to the called entrypoint. Note: you can configure parameters format by setting `micheline` query parameter.", "nullable": true }, "payload": { "type": "string", "description": "For `external` messages only. Payload bytes (in base64).", "format": "byte", "nullable": true }, "protocol": { "type": "string", "description": "For `migration` messages only. Version of the new protocol (e.g. 'nairobi_017').", "nullable": true } } }, "Software": { "type": "object", "additionalProperties": false, "properties": { "shortHash": { "type": "string", "description": "Software ID (short commit hash)" }, "firstLevel": { "type": "integer", "description": "Level of the first block baked with this software", "format": "int32" }, "firstTime": { "type": "string", "description": "Datetime of the first block baked with this software", "format": "date-time" }, "lastLevel": { "type": "integer", "description": "Level of the last block baked with this software", "format": "int32" }, "lastTime": { "type": "string", "description": "Datetime of the last block baked with this software", "format": "date-time" }, "blocksCount": { "type": "integer", "description": "Total number of blocks baked with this software", "format": "int32" }, "extras": { "description": "Off-chain extras", "nullable": true } } }, "StakingUpdateTypeParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify a staking update type to get items where the specified field is equal to the specified value.\n\nExample: `?kind=stake`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify a staking update type to get items where the specified field is not equal to the specified value.\n\nExample: `?kind.ne=finalize`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of staking update types to get items where the specified field is equal to one of the specified values.\n\nExample: `?kind.in=stake,unstake`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of staking update types to get items where the specified field is not equal to all the specified values.\n\nExample: `?kind.ni=finalize,restake`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "stake,unstake,restake,finalize,slash_staked,slash_unstaked" }, "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`). \\\nSpecify an integer number to get items where the specified field is equal to the specified value.\n\nExample: `?balance=1234`.", "format": "int64", "nullable": true }, "ne": { "type": "integer", "description": "**Not equal** filter mode. \\\nSpecify an integer number to get items where the specified field is not equal to the specified value.\n\nExample: `?balance.ne=1234`.", "format": "int64", "nullable": true }, "gt": { "type": "integer", "description": "**Greater than** filter mode. \\\nSpecify an integer number to get items where the specified field is greater than the specified value.\n\nExample: `?balance.gt=1234`.", "format": "int64", "nullable": true }, "ge": { "type": "integer", "description": "**Greater or equal** filter mode. \\\nSpecify an integer number to get items where the specified field is greater than equal to the specified value.\n\nExample: `?balance.ge=1234`.", "format": "int64", "nullable": true }, "lt": { "type": "integer", "description": "**Less than** filter mode. \\\nSpecify an integer number to get items where the specified field is less than the specified value.\n\nExample: `?balance.lt=1234`.", "format": "int64", "nullable": true }, "le": { "type": "integer", "description": "**Less or equal** filter mode. \\\nSpecify an integer number to get items where the specified field is less than or equal to the specified value.\n\nExample: `?balance.le=1234`.", "format": "int64", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of integers to get items where the specified field is equal to one of the specified values.\n\nExample: `?level.in=12,14,52,69`.", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of integers to get items where the specified field is not equal to all the specified values.\n\nExample: `?level.ni=12,14,52,69`.", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "null": { "type": "boolean", "description": "**Is null** filter mode. \\\nUse this mode to get items where the specified field is null or not.\n\nExample: `?nonce.null` or `?nonce.null=false`.", "nullable": true } }, "x-tzkt-extension": "query-parameter" }, "StakingUpdate": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT ID. \n**[sortable]**", "format": "int32" }, "level": { "type": "integer", "description": "Level of the block where the staking update happened. \n**[sortable]**", "format": "int32" }, "timestamp": { "type": "string", "description": "Timestamp of the block where the staking update happened. ", "format": "date-time" }, "cycle": { "type": "integer", "description": "For `unstake`, `restake`, `finalize` and `slash_unstaked` update types it's freezer cycle, otherwise it's cycle of the block.", "format": "int32" }, "baker": { "description": "Related baker.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "staker": { "description": "Related staker.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "type": { "type": "string", "description": "Staking update type (`stake`, `unstake`, `restake`, `finalize`, `slash_staked`, `slash_unstaked`)." }, "amount": { "type": "integer", "description": "Amount (mutez).", "format": "int64" }, "pseudotokens": { "type": "string", "description": "Amount of staking pseudotokens minted or burnt.", "nullable": true }, "roundingError": { "type": "integer", "description": "Protocol rounding error, appearing after slashing.", "format": "int64", "nullable": true }, "autostakingOpId": { "type": "integer", "description": "Id of the operation, caused the staking update.\nIf all `..OpId` fields are null, then the staking update was produced by the protocol migration.", "format": "int64", "nullable": true }, "stakingOpId": { "type": "integer", "description": "Id of the operation, caused the staking update.\nIf all `..OpId` fields are null, then the staking update was produced by the protocol migration.", "format": "int64", "nullable": true }, "delegationOpId": { "type": "integer", "description": "Id of the operation, caused the staking update.\nIf all `..OpId` fields are null, then the staking update was produced by the protocol migration.", "format": "int64", "nullable": true }, "doubleBakingOpId": { "type": "integer", "description": "Id of the operation, caused the staking update.\nIf all `..OpId` fields are null, then the staking update was produced by the protocol migration.", "format": "int64", "nullable": true }, "doubleConsensusOpId": { "type": "integer", "description": "Id of the operation, caused the staking update.\nIf all `..OpId` fields are null, then the staking update was produced by the protocol migration.", "format": "int64", "nullable": true }, "doubleEndorsingOpId": { "type": "integer", "description": "**DEPRECATED**", "format": "int64", "nullable": true }, "doublePreendorsingOpId": { "type": "integer", "description": "**DEPRECATED**", "format": "int64", "nullable": true } } }, "UnstakeRequestStatusParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (`.eq` suffix can be omitted, i.e. `?param=...` is the same as `?param.eq=...`). \\\nSpecify an unstake request status to get items where the specified field is equal to the specified value.\n\nExample: `?status=pending`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify an unstake request status to get items where the specified field is not equal to the specified value.\n\nExample: `?status.ne=finalized`.", "nullable": true } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "pending,finalizable,finalized" }, "UnstakeRequest": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT ID. \n**[sortable]**", "format": "int32" }, "cycle": { "type": "integer", "description": "Cycle at which the unstake request was created. \n**[sortable]**", "format": "int32" }, "baker": { "description": "Related baker.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "staker": { "description": "Related staker.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "requestedAmount": { "type": "integer", "description": "Initially requested amount (mutez).", "format": "int64" }, "restakedAmount": { "type": "integer", "description": "Amount that was restaked back (mutez).", "format": "int64" }, "finalizedAmount": { "type": "integer", "description": "Finalized amount (mutez).", "format": "int64" }, "slashedAmount": { "type": "integer", "description": "Slashed amount (mutez).", "format": "int64" }, "roundingError": { "type": "integer", "description": "Protocol rounding error, appearing after slashing.", "format": "int64", "nullable": true }, "actualAmount": { "type": "integer", "description": "Actual amount that was/is/will be available for finalizing. ", "format": "int64" }, "status": { "type": "string", "description": "Status of the unstake request (`pending`, `finalizable`, `finalized`)." }, "unlockCycle": { "type": "integer", "description": "Cycle at which the unstake request will become finalizable", "format": "int32" }, "unlockLevel": { "type": "integer", "description": "Level of the block at which the unstake request will become finalizable", "format": "int32" }, "unlockTime": { "type": "string", "description": "Timestamp of the block at which the unstake request will become finalizable", "format": "date-time" }, "updatesCount": { "type": "integer", "description": "Number of staking updates related to the unstake request.", "format": "int32" }, "firstLevel": { "type": "integer", "description": "Level of the block where the unstake request was created. \n**[sortable]**", "format": "int32" }, "firstTime": { "type": "string", "description": "Timestamp of the block where the unstake request was created.", "format": "date-time" }, "lastLevel": { "type": "integer", "description": "Level of the block where the unstake request was last updated. \n**[sortable]**", "format": "int32" }, "lastTime": { "type": "string", "description": "Timestamp of the block where the unstake request was last updated.", "format": "date-time" } } }, "Statistics": { "type": "object", "additionalProperties": false, "properties": { "cycle": { "type": "integer", "description": "Cycle at the end of which the statistics has been calculated. This field is only present in cyclic statistics.", "format": "int32", "nullable": true }, "date": { "type": "string", "description": "Day at the end of which the statistics has been calculated. This field is only present in daily statistics.", "format": "date-time", "nullable": true }, "level": { "type": "integer", "description": "Level of the block at which the statistics has been calculated", "format": "int32" }, "timestamp": { "type": "string", "description": "Timestamp of the block at which the statistics has been calculated (ISO 8601, e.g. `2020-02-20T02:40:57Z`)", "format": "date-time" }, "totalSupply": { "type": "integer", "description": "Total supply - all existing tokens (including locked vested funds and frozen funds) plus not yet activated fundraiser tokens", "format": "int64" }, "circulatingSupply": { "type": "integer", "description": "Circulating supply - all active tokens which can affect supply and demand (can be spent/transferred)", "format": "int64" }, "totalBootstrapped": { "type": "integer", "description": "Total amount of tokens initially created when starting the blockchain", "format": "int64" }, "totalCommitments": { "type": "integer", "description": "Total commitment amount (tokens to be activated by fundraisers)", "format": "int64" }, "totalActivated": { "type": "integer", "description": "Total amount of tokens activated by fundraisers", "format": "int64" }, "totalCreated": { "type": "integer", "description": "Total amount of created/issued tokens", "format": "int64" }, "totalBurned": { "type": "integer", "description": "Total amount of burned tokens", "format": "int64" }, "totalBanished": { "type": "integer", "description": "Total amount of tokens sent to the null-address, which is equivalent to burning", "format": "int64" }, "totalFrozen": { "type": "integer", "description": "Total amount of frozen tokens (frozen security deposits, frozen rewards and frozen fees)", "format": "int64" }, "totalRollupBonds": { "type": "integer", "description": "Total amount of tokens locked as rollup bonds", "format": "int64" }, "totalSmartRollupBonds": { "type": "integer", "description": "Total amount of tokens locked as smart rollup bonds", "format": "int64" }, "totalLost": { "type": "integer", "description": "Total amount lost due to inaccuracy of the economic protocol introduced in Oxford.\nThis amount is literally lost, because it is no longer available for the account in any mean, but for some reason it is counted as delegated.", "format": "int64" }, "totalOwnStaked": { "type": "integer", "description": "Total active bakers' own staked balance", "format": "int64" }, "totalOwnDelegated": { "type": "integer", "description": "Total active bakers' own delegated balance", "format": "int64" }, "totalExternalStaked": { "type": "integer", "description": "Total active bakers' external staked balance", "format": "int64" }, "totalExternalDelegated": { "type": "integer", "description": "Total active bakers' external delegated balance", "format": "int64" }, "totalBakingPower": { "type": "integer", "description": "Total active bakers' baking power", "format": "int64" }, "totalVotingPower": { "type": "integer", "description": "Total active bakers' voting power", "format": "int64" }, "totalBakers": { "type": "integer", "description": "Total number of active bakers", "format": "int32" }, "totalStakers": { "type": "integer", "description": "Total number of active bakers' stakers", "format": "int32" }, "totalDelegators": { "type": "integer", "description": "Total number of active bakers' delegators", "format": "int32" }, "quote": { "description": "Injected historical quote at the time of the block at which the statistics has been calculated", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/QuoteShort" } ] } } }, "MichelineParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify Micheline JSON value to get items where the specified field is equal to the specified value.\n\nExample: `?type={\"prim\":\"string\"}`.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IMicheline" } ] }, "ne": { "description": "**Not equal** filter mode. \\\nSpecify Micheline JSON value to get items where the specified field is not equal to the specified value.\n\nExample: `?balance.ne={\"prim\":\"string\"}`.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/IMicheline" } ] }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of Micheline JSON values where the specified field is equal to one of the specified values.\n\nExample: `?type.in={\"prim\":\"string\"},{\"prim\":\"nat\"}`.", "nullable": true, "items": { "$ref": "#/components/schemas/IMicheline" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of Micheline JSON values where the specified field is not equal to all the specified values.\n\nExample: `?type.ni={\"prim\":\"string\"},{\"prim\":\"nat\"}`.", "nullable": true, "items": { "$ref": "#/components/schemas/IMicheline" } } }, "x-tzkt-extension": "query-parameter" }, "Ticket": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT id. \n**[sortable]**", "format": "int64" }, "ticketer": { "description": "Contract, issued the ticket.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "rawType": { "description": "Ticket content type in Micheline format.", "oneOf": [ { "$ref": "#/components/schemas/IMicheline" } ] }, "rawContent": { "description": "Ticket content in Micheline format.", "oneOf": [ { "$ref": "#/components/schemas/IMicheline" } ] }, "content": { "description": "Ticket content in JSON format.", "nullable": true }, "typeHash": { "type": "integer", "description": "32-bit hash of the ticket content type.", "format": "int32" }, "contentHash": { "type": "integer", "description": "32-bit hash of the ticket content.", "format": "int32" }, "firstMinter": { "description": "Account, minted the ticket first.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "firstLevel": { "type": "integer", "description": "Level of the block where the ticket was first seen. \n**[sortable]**", "format": "int32" }, "firstTime": { "type": "string", "description": "Timestamp of the block where the ticket was first seen.", "format": "date-time" }, "lastLevel": { "type": "integer", "description": "Level of the block where the ticket was last seen. \n**[sortable]**", "format": "int32" }, "lastTime": { "type": "string", "description": "Timestamp of the block where the ticket 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 amount minted." }, "totalBurned": { "type": "string", "description": "Total amount burned." }, "totalSupply": { "type": "string", "description": "Total amount exists." } } }, "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`). \\\nSpecify a `nat` value to get items where the specified field is equal to the specified value.\n\nExample: `?balance=1234`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify a `nat` value to get items where the specified field is not equal to the specified value.\n\nExample: `?balance.ne=1234`.", "nullable": true }, "gt": { "type": "string", "description": "**Greater than** filter mode. \\\nSpecify a `nat` value to get items where the specified field is greater than the specified value.\n\nExample: `?balance.gt=1234`.", "nullable": true }, "ge": { "type": "string", "description": "**Greater or equal** filter mode. \\\nSpecify a `nat` value to get items where the specified field is greater than equal to the specified value.\n\nExample: `?balance.ge=1234`.", "nullable": true }, "lt": { "type": "string", "description": "**Less than** filter mode. \\\nSpecify a `nat` value to get items where the specified field is less than the specified value.\n\nExample: `?balance.lt=1234`.", "nullable": true }, "le": { "type": "string", "description": "**Less or equal** filter mode. \\\nSpecify a `nat` value to get items where the specified field is less than or equal to the specified value.\n\nExample: `?balance.le=1234`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of `nat` values to get items where the specified field is equal to one of the specified values.\n\nExample: `?level.in=12,14,52,69`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of `nat` values to get items where the specified field is not equal to all the specified values.\n\nExample: `?level.ni=12,14,52,69`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter" }, "TicketBalance": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT id. \n**[sortable]**", "format": "int64" }, "ticket": { "description": "Ticket info. \nClick on the field to expand more details.", "oneOf": [ { "$ref": "#/components/schemas/TicketInfo" } ] }, "account": { "description": "Owner account. \nClick on the field to expand more details.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "balance": { "type": "string", "description": "Balance. \n**[sortable]**" }, "transfersCount": { "type": "integer", "description": "Total number of transfers, affecting the ticket balance. \n**[sortable]**", "format": "int32" }, "firstLevel": { "type": "integer", "description": "Level of the block where the ticket balance was first changed. \n**[sortable]**", "format": "int32" }, "firstTime": { "type": "string", "description": "Timestamp of the block where the ticket balance was first changed.", "format": "date-time" }, "lastLevel": { "type": "integer", "description": "Level of the block where the ticket balance was last changed. \n**[sortable]**", "format": "int32" }, "lastTime": { "type": "string", "description": "Timestamp of the block where the ticket balance was last changed.", "format": "date-time" } } }, "TicketTransfer": { "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 transfer was made. \n**[sortable]**", "format": "int32" }, "timestamp": { "type": "string", "description": "Timestamp of the block, at which the transfer was made.", "format": "date-time" }, "ticket": { "description": "Ticket info. \nClick on the field to expand more details.", "oneOf": [ { "$ref": "#/components/schemas/TicketInfo" } ] }, "from": { "description": "Sender account. \nClick on the field to expand more details.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "to": { "description": "Recipient account. \nClick on the field to expand more details.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "amount": { "type": "string", "description": "Amount of tickets transferred. \n**[sortable]**" }, "transactionId": { "type": "integer", "description": "Internal TzKT id of the transaction operation, caused the ticket transfer.", "format": "int64", "nullable": true }, "transferTicketId": { "type": "integer", "description": "Internal TzKT id of the transfer_ticket operation, caused the ticket transfer.", "format": "int64", "nullable": true }, "smartRollupExecuteId": { "type": "integer", "description": "Internal TzKT id of the smart_rollup_execute operation, caused the ticket transfer.", "format": "int64", "nullable": true } } }, "TicketBalanceShort": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT id. \n**[sortable]**", "format": "int64" }, "ticket": { "description": "Ticket info. \nClick on the field to expand more details.", "oneOf": [ { "$ref": "#/components/schemas/TicketInfoShort" } ] }, "account": { "description": "Owner account. \nClick on the field to expand more details.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "balance": { "type": "string", "description": "Balance. " } } }, "TicketInfoShort": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Internal TzKT id.", "format": "int64" }, "ticketer": { "description": "Contract, issued the ticket.", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "rawType": { "description": "Ticket content type in Micheline format.", "oneOf": [ { "$ref": "#/components/schemas/IMicheline" } ] }, "rawContent": { "description": "Ticket content in Micheline format.", "oneOf": [ { "$ref": "#/components/schemas/IMicheline" } ] }, "content": { "description": "Ticket content in JSON format.", "nullable": true }, "typeHash": { "type": "integer", "description": "32-bit hash of the ticket content type.\nThis field can be used for searching similar tickets (which have the same type).", "format": "int32" }, "contentHash": { "type": "integer", "description": "32-bit hash of the ticket content.\nThis field can be used for searching same tickets (which have the same content).", "format": "int32" } } }, "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`). \\\nSpecify token standard (`fa1.2` or `fa2`) to get items where the specified field is equal to the specified value.\n\nExample: `?type=fa2`.", "nullable": true }, "in": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify token standard (`fa1.2` or `fa2`) to get items where the specified field is not equal to the specified value.\n\nExample: `?type.ne=fa1.2`.", "nullable": true } } }, "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`). \\\nSpecify token standard (`fa1.2` or `fa2`) to get items where the specified field is equal to the specified value.\n\nExample: `?type=fa2`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify token standard (`fa1.2` or `fa2`) to get items where the specified field is not equal to the specified value.\n\nExample: `?type.ne=fa1.2`.", "nullable": true } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "fa1.2,fa2" }, "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 } } }, "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" } } }, "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 } } }, "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]**" } } }, "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 } } }, "Proposal": { "type": "object", "additionalProperties": false, "properties": { "hash": { "type": "string", "description": "Hash of the proposal, which representing a tarball of concatenated .ml/.mli source files" }, "initiator": { "description": "Information about the baker (delegate) submitted the proposal", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "firstPeriod": { "type": "integer", "description": "The first voting period where the proposal was active", "format": "int32" }, "lastPeriod": { "type": "integer", "description": "The last voting period where the proposal was active", "format": "int32" }, "epoch": { "type": "integer", "description": "The voting epoch where the proposal was active", "format": "int32" }, "upvotes": { "type": "integer", "description": "The total number of upvotes (proposal operations)", "format": "int32" }, "votingPower": { "type": "integer", "description": "The total voting power of bakers, upvoted the proposal", "format": "int64" }, "status": { "type": "string", "description": "Status of the proposal\n`active` - the proposal in the active state\n`accepted` - the proposal was accepted\n`rejected` - the proposal was rejected due to too many \"nay\" ballots\n`skipped` - the proposal was skipped due to the quorum was not reached" }, "extras": { "description": "Off-chain extras", "nullable": true } } }, "VotingPeriod": { "type": "object", "additionalProperties": false, "properties": { "index": { "type": "integer", "description": "Index of the voting period, starting from zero", "format": "int32" }, "epoch": { "type": "integer", "description": "Index of the voting epoch, starting from zero", "format": "int32" }, "firstLevel": { "type": "integer", "description": "The height of the block in which the period starts", "format": "int32" }, "startTime": { "type": "string", "description": "The timestamp of the block in which the period starts", "format": "date-time" }, "lastLevel": { "type": "integer", "description": "The height of the block in which the period ends", "format": "int32" }, "endTime": { "type": "string", "description": "The timestamp of the block in which the period ends", "format": "date-time" }, "kind": { "type": "string", "description": "Kind of the voting period:\n`proposal` - delegates can submit protocol amendment proposals using the proposal operation\n`exploration` - bakers (delegates) may vote on the top-ranked proposal from the previous Proposal Period using the ballot operation\n`testing` - If the proposal is approved in the Exploration Period, the testing (or 'cooldown') period begins and bakers start testing the new protocol\n`promotion` - delegates can cast one vote to promote or not the tested proposal using the ballot operation\n`adoption` - after the proposal is actually accepted, the ecosystem has some time to prepare to the upgrade" }, "status": { "type": "string", "description": "Status of the voting period:\n`active` - means that the voting period is in progress\n`no_proposals` - means that there were no proposals during the voting period\n`no_quorum` - means that there was a voting but the quorum was not reached\n`no_supermajority` - means that there was a voting but the supermajority was not reached\n`no_single_winner` - means that there were multiple winning proposals with the same voting power\n`success` - means that the period was finished with positive voting result" }, "dictator": { "type": "string", "description": "Status of the governance dictator:\n`none` - means that there were no actions by the dictator \n`abort` - means that the epoch was aborted by the dictator\n`reset` - means that the period was reset by the dictator\n`submit` - means that the dictator submitted a proposal" }, "totalBakers": { "type": "integer", "description": "The number of bakers on the voters list", "format": "int32" }, "totalVotingPower": { "type": "integer", "description": "Total voting power of bakers on the voters list", "format": "int64" }, "upvotesQuorum": { "type": "number", "description": "Upvotes quorum percentage (only for proposal period)", "format": "double", "nullable": true }, "proposalsCount": { "type": "integer", "description": "The number of proposals injected during the voting period (only for proposal period)", "format": "int32", "nullable": true }, "topUpvotes": { "type": "integer", "description": "This is how many upvotes (proposal operations) the most upvoted proposal has (only for proposal period)", "format": "int32", "nullable": true }, "topVotingPower": { "type": "integer", "description": "This is how much voting power the most upvoted proposal has (only for proposal period)", "format": "int64", "nullable": true }, "ballotsQuorum": { "type": "number", "description": "Ballots quorum percentage (only for exploration and promotion periods)", "format": "double", "nullable": true }, "supermajority": { "type": "number", "description": "Supermajority percentage (only for exploration and promotion periods)", "format": "double", "nullable": true }, "yayBallots": { "type": "integer", "description": "The number of the ballots with \"yay\" vote (only for exploration and promotion periods)", "format": "int32", "nullable": true }, "yayVotingPower": { "type": "integer", "description": "Total voting power of the ballots with \"yay\" vote (only for exploration and promotion periods)", "format": "int64", "nullable": true }, "nayBallots": { "type": "integer", "description": "The number of the ballots with \"nay\" vote (only for exploration and promotion periods)", "format": "int32", "nullable": true }, "nayVotingPower": { "type": "integer", "description": "Total voting power of the ballots with \"nay\" vote (only for exploration and promotion periods)", "format": "int64", "nullable": true }, "passBallots": { "type": "integer", "description": "The number of the ballots with \"pass\" vote (only for exploration and promotion periods)", "format": "int32", "nullable": true }, "passVotingPower": { "type": "integer", "description": "Total voting power of the ballots with \"pass\" vote (only for exploration and promotion periods)", "format": "int64", "nullable": true } } }, "VoterSnapshot": { "type": "object", "additionalProperties": false, "properties": { "delegate": { "description": "Voter identity", "oneOf": [ { "$ref": "#/components/schemas/Alias" } ] }, "votingPower": { "type": "integer", "description": "Baker's voting power", "format": "int64" }, "status": { "type": "string", "description": "Voter's status:\n`none` - the voter did nothing\n`upvoted` - the voter upvoted at least one proposal\n`voted_yay` - the voter voted \"yay\"\n`voted_nay` - the voter voted \"nay\"\n`voted_pass` - the voter voted \"pass\"" } } }, "VoterStatusParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify a voter status to get items where the specified field is equal to the specified value.\n\nExample: `?status=none`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify a voter status to get items where the specified field is not equal to the specified value.\n\nExample: `?status.ne=none`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of voter statuses to get items where the specified field is equal to one of the specified values.\n\nExample: `?status.in=voted_yay,voted_nay`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of voter statuses to get items where the specified field is not equal to all the specified values.\n\nExample: `?status.ni=none,upvoted`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "none,upvoted,voted_yay,voted_nay,voted_pass" }, "VotingEpoch": { "type": "object", "additionalProperties": false, "properties": { "index": { "type": "integer", "description": "Index of the voting epoch, starting from zero", "format": "int32" }, "firstLevel": { "type": "integer", "description": "The height of the block in which the epoch starts", "format": "int32" }, "startTime": { "type": "string", "description": "The timestamp of the block in which the epoch starts", "format": "date-time" }, "lastLevel": { "type": "integer", "description": "The height of the block in which the epoch ends", "format": "int32" }, "endTime": { "type": "string", "description": "The timestamp of the block in which the epoch ends", "format": "date-time" }, "status": { "type": "string", "description": "Status of the voting epoch:\n`no_proposals` - there were no proposals proposed\n`voting` - there was at least one proposal and the voting is in progress\n`completed` - voting successfully completed and the proposal was accepted\n`failed` - voting was not completed due to either quorum or supermajority was not reached" }, "periods": { "type": "array", "description": "Voting periods in the epoch", "items": { "$ref": "#/components/schemas/VotingPeriod" } }, "proposals": { "type": "array", "description": "Proposals pushed during the voting epoch (null, if there were no proposals).", "items": { "$ref": "#/components/schemas/Proposal" } } } }, "EpochStatusParameter": { "type": "object", "additionalProperties": false, "properties": { "eq": { "type": "string", "description": "**Equal** filter mode (optional, i.e. `param.eq=123` is the same as `param=123`). \\\nSpecify an epoch status to get items where the specified field is equal to the specified value.\n\nExample: `?status=completed`.", "nullable": true }, "ne": { "type": "string", "description": "**Not equal** filter mode. \\\nSpecify an epoch status to get items where the specified field is not equal to the specified value.\n\nExample: `?status.ne=no_proposals`.", "nullable": true }, "in": { "type": "array", "description": "**In list** (any of) filter mode. \\\nSpecify a comma-separated list of epoch statuses to get items where the specified field is equal to one of the specified values.\n\nExample: `?status.in=completed,failed`.", "nullable": true, "items": { "type": "string" } }, "ni": { "type": "array", "description": "**Not in list** (none of) filter mode. \\\nSpecify a comma-separated list of epoch statuses to get items where the specified field is not equal to all the specified values.\n\nExample: `?status.ni=completed,failed`.", "nullable": true, "items": { "type": "string" } } }, "x-tzkt-extension": "query-parameter", "x-tzkt-query-parameter": "no_proposals,voting,completed,failed" } } }, "tags": [ { "name": "Get Started", "description": "TzKT WebSocket API is based on [SignalR](https://docs.microsoft.com/aspnet/signalr/overview/getting-started/introduction-to-signalr)\nthat enables receiving data from the Tezos blockchain in real-time.\n\nThis is a very useful feature, especially when you need to receive updates immediately, as soon as they appear on the node and are indexed by the indexer.\nAlso it allows to significantly simplify client's logic responsible for updating/synchronizing data.\n\nWebSocket API base URL: `https://{baseUrl}/v1/ws`\n\n## Message types\n\nAfter connecting to the WebSocket and subscribing, the client starts receiving messages from the server.\nThere are three message types that the server sends to the client:\n\n#### 1. State message\n\n````js\n{\n\ttype: 0, // 0 - state message\n\tstate: 0 // subscription state\n}\n````\n\nThis is the very first message the client receives from the server after opening a subscription. \nThis message is a kind of confirmation that the subscription has been successfully processed.\n\nThere is just one meaningful field - `state`, that represents current state of the subscription.\nThe type of that field depends on a particular subscription (see documentation on each subscription).\nFor example, if you subscribe to new blocks, the `state` will contain a level of the last sent block.\nSo if you receive a state message with `state: 1300123`, the next block you may expect to receive will be `1300124`.\n\nState can be used to fetch historical data from the REST API right after opening a subscription, so that there will be no nor misses nor duplicates.\n\n#### 2. Data message\t \n\n````js\n{\n\ttype: 1, // 1 - data message\n\tstate: 0, // subscription state\n\tdata: {} // data: object or array, depending on subscription\n}\n````\n\nAfter subscription is registered and state message is received, client will receive data messages. As you can see, `data` is an array (array of\nblocks, operations, or whatever you have subscribed to), that means you may receive multiple items in a single message,\nwhich is great for performance and network traffic.\n\nTzKT WebSocket API operates with the same data models as the REST API to achieve full compatibility and data consistency.\n\n#### 3. Reorg message\t\n\n````js\n{\t\t\t \n\ttype: 2, // 2 - reorg message\n\tstate: 0 // subscription state\n}\n````\n\nReorg messages signal about chain reorganizations, when some blocks, including all operations, are rolled back\nin favor of blocks with higher weight. Chain reorgs happen quite often, so it's not something you can ignore.\nYou have to handle such messages correctly, otherwise you will likely accumulate duplicate data or, worse, invalid data.\n\nFor example, if you receive blocks `10`, `11`, `12`, `13` and then receive reorg message with `state: 11`,\nyou should remove blocks `12` and `13` (if you saved them) as they are no longer valid.", "x-tagGroup": "ws" }, { "name": "Subscriptions", "description": "## SubscribeToHead\n\nSends the blockchain head every time it is changed.\n\t\t\n### Method \n\n`SubscribeToHead`\n\n### Channel \n\n`head`\n\n### Parameters\n\nNo parameters.\n\n### Data model\n\nSame as in [/head](#tag/Head)\n\n### State\n\nState contains level (`int`) of the last processed head.\n\n### Example\n\n````js\nconnection.on(\"head\", (msg) => { console.log(msg); });\nawait connection.invoke(\"SubscribeToHead\");\n````\n\n---\n\n## SubscribeToCycles\n\nNotifies of the start of a new cycle with a specified delay.\n\n### Method\n\n`SubscribeToCycles`\n\n### Channel\n\n`cycles`\n\n### Parameters\n\n````js\n{\n\tdelayBlocks: 2, // number of blocks (2 by default) to delay a new cycle notification\n // should be >= 2 (to not worry abour reorgs) and < cycle size\n}\n````\n\n### Data model\n\nSame as in [/cycle](#operation/Cycles_GetByIndex)\n\n### State\n\nState contains an index (`int`) of the last processed cycle.\n\n### Example\n\n````js\nconnection.on(\"cycles\", (msg) => { console.log(msg); });\nawait connection.invoke(\"SubscribeToCycles\");\n````\n\n---\n\n## SubscribeToBlocks \n\nSends blocks added to the blockchain\n\t\t\n### Method \n\n`SubscribeToBlocks`\n\n### Channel \n\n`blocks`\n\n### Parameters\n\nNo parameters.\n\n### Data model\n\nSame as in [/blocks](#operation/Blocks_GetHead)\n\n### State\n\nState contains level (`int`) of the last processed block.\n\n### Example\n\n````js\nconnection.on(\"blocks\", (msg) => { console.log(msg); });\nawait connection.invoke(\"SubscribeToBlocks\");\n````\n\n---\n\n## SubscribeToAccounts\n\nSends touched accounts (affected by any operation in any way).\n\n### Method\n\n`SubscribeToAccounts`\n\n### Channel\n\n`accounts`\n\n### Parameters\n\n````js\n{\n\taddresses: [], // array of address you want to subscribe to\n}\n````\n\n> **Note:** you can invoke this method multiple times with different parameters to register multiple subscriptions.\n\n### Data model\n\n`data` is an array of items described in response section of [/accounts/{address}](#operation/Accounts_GetByAddress) request.\n\n### State\n\nState contains level (`int`) of the last processed block.\n\n### Example\n\n````js\nconnection.on(\"accounts\", (msg) => { console.log(msg); });\n// subscribe to an account\nawait connection.invoke(\"SubscribeToAccounts\", { addresses: [ 'tz1234...' ] });\n````\n\n---\t\t\t\n\n## SubscribeToOperations \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t \nSends operations of specified types or related to specified accounts, included into the blockchain\n\t\t\n### Method \n\n`SubscribeToOperations`\n\n### Channel \n\n`operations`\n\n### Parameters\n\n````js\n{\n address: '', // address you want to subscribe to,\n // or null if you want to subscribe for all operations\n\n codeHash: 0, // hash of the code of the contract to which the operation is related\n // (can be used with 'transaction', 'origination', 'delegation' types only)\n\n types: '' // comma-separated list of operation types, any of:\n // 'transaction', 'origination', 'delegation', 'reveal', etc.\n}\n````\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t \n> **Note:** you can invoke this method multiple times with different parameters to register multiple subscriptions.\n\n### Data model\n\nSame as in [/operations/transactions](#operation/Operations_GetTransactions), [/operations/delegations](#operation/Operations_GetDelegations), etc.\n\n### State\n\nState contains level (`int`) of the last processed block.\n\n### Example\n\n````js\nconnection.on(\"operations\", (msg) => { console.log(msg); });\n// subscribe to all transactions\nawait connection.invoke(\"SubscribeToOperations\", { types: 'transaction' });\n// subscribe to all transactions of the entire contract family\nawait connection.invoke(\"SubscribeToOperations\", { types: 'transaction', codeHash: 1928472 });\n// subscribe to all delegations and originations related to the address 'tz1234...'\nawait connection.invoke(\"SubscribeToOperations\", { address: 'tz1234...', types: 'delegation,origination' });\n````\n\n---\t\t\t\n\n## SubscribeToBigMaps \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t \nSends bigmap updates\n\t\t\n### Method \n\n`SubscribeToBigMaps`\n\n### Channel \n\n`bigmaps`\n\n### Parameters\n\nThis method accepts the following parameters:\n\n````js\n{\n\tptr: 0, // ptr of the bigmap you want to subscribe to\n\ttags: [], // array of bigmap tags ('metadata' or 'token_metadata')\n\tcontract: '', // contract address\n\tpath: '' // path to the bigmap in the contract storage\n}\n````\n\nYou can set various combinations of these fields to configure what you want to subscribe to. For example:\n\n````js\n// subscribe to all bigmaps\n{\n}\t \n\n// subscribe to all bigmaps with specific tags\n{\t\t\n\ttags: ['metadata', 'token_metadata']\n}\n\n// subscribe to all bigmaps of the specific contract\n{\n\tcontract: 'KT1...'\n}\n\n// subscribe to all bigmaps of the specific contract with specific tags\n{\n\tcontract: 'KT1...',\n\ttags: ['metadata']\n}\n\n// subscribe to specific bigmap by ptr\n{\n\tptr: 123\n}\n\t\n// subscribe to specific bigmap by path\n{\n\tcontract: 'KT1...',\n\tpath: 'ledger'\n}\n````\n\n> **Note:** you can invoke this method multiple times with different parameters to register multiple subscriptions.\n\n### Data model\n\nSame as in [/bigmaps/updates](#operation/BigMaps_GetBigMapUpdates).\n\n### State\n\nState contains level (`int`) of the last processed block.\n\n### Example\n\n````js\nconnection.on(\"bigmaps\", (msg) => { console.log(msg); });\n// subscribe to all bigmaps of the 'KT123...' contract\nawait connection.invoke(\"SubscribeToBigMaps\", { contract: 'KT123...' });\n// subscribe to bigmap with ptr 123\nawait connection.invoke(\"SubscribeToBigMaps\", { ptr: 123 });\n````\n\n---\t\t\t\n\n## SubscribeToTokenBalances\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t \nSends token balances when they are updated\n\t\t\n### Method \n\n`SubscribeToTokenBalances`\n\n### Channel \n\n`token_balances`\n\n### Parameters\n\nThis method accepts the following parameters:\n\n````js\n{\n\taccount: '', // address of the account that holds tokens\n\tcontract: '', // address of the contract that manages tokens\n\ttokenId: '' // id of the token within the specified contract\n}\n````\n\nYou can set various combinations of these fields to configure what you want to subscribe to. For example:\n\n````js\n// subscribe to all token balance updates\n{\n}\n\n// subscribe to balance updates of all tokens within the contract\n{\n\tcontract: 'KT1...'\n}\n\n// subscribe to balance updates of a particular token\n{\n\tcontract: 'KT1...',\n\ttokenId: '0'\n} \t \n\n// subscribe to token balance updates for the account\n{\t\t\n\taccount: 'tz1...'\n} \t \n\n// subscribe to balance updates of all tokens within the contract for the account\n{\t\t\n\taccount: 'tz1...',\n\tcontract: 'KT1...'\n} \n\n// subscribe to a particular token balance updates for the account\n{\t\t\n\taccount: 'tz1...',\n\tcontract: 'KT1...',\n\ttokenId: '0'\n}\n````\n\n> **Note:** you can invoke this method multiple times with different parameters to register multiple subscriptions.\n\n### Data model\n\nSame as in [/tokens/balances](#operation/Tokens_GetTokenBalances).\n\n### State\n\nState contains level (`int`) of the last processed block.\n\n### Example\n\n````js\nconnection.on(\"token_balances\", (msg) => { console.log(msg); });\n// subscribe to all token balances of the 'tz123...' account\nawait connection.invoke(\"SubscribeToTokenBalances\", { account: 'tz123...' });\n````\n\n---\t\t\t\n\n## SubscribeToTokenTransfers\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t \nSends token transfers\n\t\t\n### Method \n\n`SubscribeToTokenTransfers`\n\n### Channel \n\n`transfers`\n\n### Parameters\n\nThis method accepts the following parameters:\n\n````js\n{\n\taccount: '', // address of the account that sends/receives tokens\n\tcontract: '', // address of the contract that manages tokens\n\ttokenId: '' // id of the token within the specified contract\n}\n````\n\nYou can set various combinations of these fields to configure what you want to subscribe to. For example:\n\n````js\n// subscribe to all transfers\n{\n}\n\n// subscribe to transfers of all tokens within the contract\n{\n\tcontract: 'KT1...'\n}\n\n// subscribe to transfers of a particular token\n{\n\tcontract: 'KT1...',\n\ttokenId: '0'\n} \t \n\n// subscribe to transfers from/to the account\n{\t\t\n\taccount: 'tz1...'\n} \t \n\n// subscribe to transfers of all tokens within the contract from/to the account\n{\t\t\n\taccount: 'tz1...',\n\tcontract: 'KT1...'\n} \n\n// subscribe to transfers of a particular token from/to the account\n{\t\t\n\taccount: 'tz1...',\n\tcontract: 'KT1...',\n\ttokenId: '0'\n}\n````\n\n> **Note:** you can invoke this method multiple times with different parameters to register multiple subscriptions.\n\n### Data model\n\nSame as in [/tokens/transfers](#operation/Tokens_GetTokenTransfers).\n\n### State\n\nState contains level (`int`) of the last processed block.\n\n### Example\n\n````js\nconnection.on(\"transfers\", (msg) => { console.log(msg); });\n// subscribe to all transfers of the 'tz123...' account\nawait connection.invoke(\"SubscribeToTokenTransfers\", { account: 'tz123...' });\n````\n\n---\t\t\n\n## SubscribeToTicketBalances\n\nSends ticket balances when they are updated\n\n### Method\n\n`SubscribeToTicketBalances`\n\n### Channel\n\n`ticket_balances`\n\n### Parameters\n\nThis method accepts the following parameters:\n\n````js\n{\n\taccount: '', // address of the account that holds tickets\n\tticketer: '', // address of the ticketer\n}\n````\n\nYou can set various combinations of these fields to configure what you want to subscribe to. For example:\n\n````js\n// subscribe to all ticket balance updates\n{\n}\n\n// subscribe to balance updates of all tickets within the ticketer\n{\n\tticketer: 'KT1...'\n}\t \n\n// subscribe to ticket balance updates for the account\n{\t\t\n\taccount: 'tz1...'\n} \t \n\n// subscribe to balance updates of all tickets within the ticketer for the account\n{\t\t\n\taccount: 'tz1...',\n\tticketer: 'KT1...'\n} \n````\n\n> **Note:** you can invoke this method multiple times with different parameters to register multiple subscriptions.\n\n### Data model\n\nSame as in [/tickets/balances](#operation/Tickets_GetTicketBalances).\n\n### State\n\nState contains level (`int`) of the last processed block.\n\n### Example\n\n````js\nconnection.on(\"ticket_balances\", (msg) => { console.log(msg); });\n// subscribe to all ticket balances of the 'tz123...' account\nawait connection.invoke(\"SubscribeToTicketBalances\", { account: 'tz123...' });\n````\n\n---\t\t\t\n\n## SubscribeToTicketTransfers\n\nSends ticket transfers\n\n### Method\n\n`SubscribeToTicketTransfers`\n\n### Channel\n\n`ticket_transfers`\n\n### Parameters\n\nThis method accepts the following parameters:\n\n````js\n{\n\taccount: '', // address of the account that sends/receives tickets\n\tticketer: '', // address of the ticketer\n}\n````\n\nYou can set various combinations of these fields to configure what you want to subscribe to. For example:\n\n````js\n// subscribe to all transfers\n{\n}\n\n// subscribe to transfers of all tickets within the ticketer\n{\n\tticketer: 'KT1...'\n} \n\n// subscribe to transfers from/to the account\n{\t\t\n\taccount: 'tz1...'\n} \t \n\n// subscribe to transfers of all tickets within the ticketer from/to the account\n{\t\t\n\taccount: 'tz1...',\n\tticketer: 'KT1...'\n}\n````\n\n> **Note:** you can invoke this method multiple times with different parameters to register multiple subscriptions.\n\n### Data model\n\nSame as in [/tickets/transfers](#operation/Tickets_GetTicketTransfers).\n\n### State\n\nState contains level (`int`) of the last processed block.\n\n### Example\n\n````js\nconnection.on(\"ticket_transfers\", (msg) => { console.log(msg); });\n// subscribe to all transfers of the 'tz123...' account\nawait connection.invoke(\"SubscribeToTicketTransfers\", { account: 'tz123...' });\n````\n\n---\t\t\n\n## SubscribeToEvents \n\t\t\t\t\t\t\t\t\t\t\t\t\t\t \nSends contract events\n\t\t\n### Method \n\n`SubscribeToEvents`\n\n### Channel \n\n`events`\n\n### Parameters\n\nThis method accepts the following parameters:\n\n````js\n{\n\tcodeHash: 0, // hash of the contract code\n\tcontract: '', // contract address\n\ttag: '', // event tag\n}\n````\n\nYou can set various combinations of these fields to configure what you want to subscribe to. For example:\n\n````js\n// subscribe to all events\n{\n}\t \n\n// subscribe to events with specific tag\n{\t\t\n\ttag: 'transfer'\n}\n\n// subscribe to events of the specific contract\n{\n\tcontract: 'KT1...'\n}\n\n// subscribe to events of the specific contract with specific tag\n{\n\tcontract: 'KT1...',\n\ttag: 'transfer'\n}\n\n// subscribe to events of the 'family' of contracts\n{\n\tcodeHash: 1234\n}\n\t\n// subscribe to events of the 'family' of contracts with specific tag\n{\n\tcodeHash: 1234,\n\ttag: 'transfer'\n}\n````\n\n> **Note:** you can invoke this method multiple times with different parameters to register multiple subscriptions.\n\n### Data model\n\nSame as in [/contracts/events](#operation/Events_GetContractEvents).\n\n### State\n\nState contains level (`int`) of the last processed block.\n\n### Example\n\n````js\nconnection.on(\"events\", (msg) => { console.log(msg); });\n// subscribe to all events of the 'KT123...' contract\nawait connection.invoke(\"SubscribeToEvents\", { contract: 'KT123...' });\n````\n\n---\n", "x-tagGroup": "ws" }, { "name": "Examples", "description": "Here are some examples of a simple client app in different languages.\n\n## C# simple client\n\nInstall SignalR package:\n\n````sh\n> dotnet add package Microsoft.AspNetCore.SignalR.Client\n// if you use .NET 5.0 you will likely also need:\n> dotnet add package System.Text.Encodings.Web\n````\n\nSee more details [here](https://docs.microsoft.com/aspnet/core/tutorials/signalr).\n\n````cs\nusing System;\nusing System.Text.Json;\nusing System.Threading.Tasks;\nusing Microsoft.AspNetCore.SignalR.Client;\n\nnamespace TestConsoleCore\n{\n class Program\n {\n static async Task Main(string[] args)\n {\n var connection = new HubConnectionBuilder()\n .WithUrl(\"https://api.tzkt.io/v1/ws\")\n .Build();\n\n async Task Init(Exception arg = null)\n {\n // open connection\n await connection.StartAsync();\n // subscribe to head\n await connection.InvokeAsync(\"SubscribeToHead\");\n // subscribe to account transactions\n await connection.InvokeAsync(\"SubscribeToOperations\", new\n {\n address = \"KT19kgnqC5VWoxktLRdRUERbyUPku9YioE8W\",\n types = \"transaction\"\n });\n }\n\n // auto-reconnect\n connection.Closed += Init;\n\n connection.On(\"head\", (JsonElement msg) =>\n {\n Console.WriteLine(msg.GetRawText());\n });\n\n connection.On(\"operations\", (JsonElement msg) =>\n {\n Console.WriteLine(msg.GetRawText());\n });\n\n await Init();\n\n Console.ReadLine();\n\n connection.Closed -= Init;\n await connection.StopAsync();\n await connection.DisposeAsync();\n }\n }\n}\n````\n\n---\n\n## JS simple client\n\nInstall SignalR package via npm:\n\n````sh\n> npm install @microsoft/signalr\n\nconst signalR = require(\"@microsoft/signalr\");\n````\n\nor via CDN:\n \n````sh\n\n````\n\nSee more details [here](https://docs.microsoft.com/aspnet/core/signalr/javascript-client).\n\n````js\nconst connection = new signalR.HubConnectionBuilder()\n\t.withUrl(\"https://api.tzkt.io/v1/ws\")\n\t.build();\n\nasync function init() {\n\t// open connection\n\tawait connection.start();\n\t// subscribe to head\n\tawait connection.invoke(\"SubscribeToHead\");\n\t// subscribe to account transactions\n\tawait connection.invoke(\"SubscribeToOperations\", {\n\t\taddress: 'KT19kgnqC5VWoxktLRdRUERbyUPku9YioE8W',\n\t\ttypes: 'transaction'\n\t});\n};\n\n// auto-reconnect\nconnection.onclose(init);\n\nconnection.on(\"head\", (msg) => {\n\tconsole.log(msg);\t\t\t\n});\n\nconnection.on(\"operations\", (msg) => {\n\tconsole.log(msg);\t\t\t\n});\n\ninit();\n````\n\n---\n\n## Python simple client\n\nInstall pysignalr package via `pypi`:\n\n````sh\n> pip install pysignalr\n````\n\nSee more details [here](https://github.com/baking-bad/pysignalr).\n\n````python\nimport asyncio\nfrom contextlib import suppress\nfrom typing import Any\nfrom typing import Dict\nfrom typing import List\n\nfrom pysignalr.client import SignalRClient\nfrom pysignalr.messages import CompletionMessage\n\n\nasync def on_open() -> None:\n print('Connected to the server')\n\n\nasync def on_close() -> None:\n print('Disconnected from the server')\n\n\nasync def on_message(message: List[Dict[str, Any]]) -> None:\n print(f'Received message: {message}')\n\n\nasync def on_error(message: CompletionMessage) -> None:\n print(f'Received error: {message.error}')\n\n\nasync def main() -> None:\n client = SignalRClient('https://api.tzkt.io/v1/ws')\n\n client.on_open(on_open)\n client.on_close(on_close)\n client.on_error(on_error)\n client.on('operations', on_message)\n\n await asyncio.gather(\n client.run(),\n client.send('SubscribeToOperations', [{}]),\n )\n\n\nwith suppress(KeyboardInterrupt, asyncio.CancelledError):\n asyncio.run(main())\n````\n", "x-tagGroup": "ws" }, { "name": "Typescript SDK", "description": "TzKT API is accompanied by a Typescript SDK you can use both on the client side and on the backend. \nIt offers fully typed response models and a convenient query builder with autocompletion. Also it is designed to support tree-shaking and to introduce a minimal overhead to the bundle size.\n\nCheck out the following resources:\n* [SDK reference](https://sdk.tzkt.io/)\n* [GitHub repo](https://github.com/tzkt/api-sdk-ts)\n\n## Installation\n\nFor querying REST API:\n```bash\nnpm i @tzkt/sdk-api\n```\n\nFor WebSocket API:\n```bash\nnpm i @tzkt/sdk-events\n```\n\n## Usage\n\n### Simplest request\n\nSimplest example of getting double baking operations, accused of being such by a certain address.\n\n```ts\nimport { operationsGetDoubleBaking } from '@tzkt/sdk-api'\n\nawait operationsGetDoubleBaking(\n {\n quote: 'Btc',\n accuser: {\n in: ['tz3VEZ4k6a4Wx42iyev6i2aVAptTRLEAivNN']\n }\n }\n)\n```\n\n### Overriding base API URL\n\nYou may override base URL used by the package in the following manner. This may come useful should you want to make requests to a test network or to your custom server.\n\n```ts\nimport * as api from \"@tzkt/sdk-api\";\n\napi.defaults.baseUrl = \"https://api.ithacanet.tzkt.io/\";\n```\n\nIn case you need to override request headers, this is also possible.\n\n```ts\nimport * as api from \"@tzkt/sdk-api\";\n\napi.defaults.headers = {\n access_token: \"secret\",\n};\n```\n\nPlease refer to the [original documentation](https://github.com/cellular/oazapfts#overriding-the-defaults) for more details on how to configure defaults.\n\n### Subscriptions\n\nCreate an instance of events service specifying TzKT WebSocket endpoint.\n```js\nimport { EventsService } from \"@tzkt/sdk-events\";\n\nconst events = new EventsService({ url: \"https://api.tzkt.io/v1/ws\", reconnect: true });\n```\n\nConnection is not initiated until the first request (lazy connection):\n```js\nconst sub = events.operations({ types: [ 'origination' ] })\n .subscribe({ next: console.log });\n```\n\nEvents service implements subscription router internally (on TzKT your subscriptions are aggregated) hence you can always \"unsubscribe\" from new updates (however it does not change anything on the TzKT side, just stops firing your observer):\n```js\nsub.unsubscribe();\n```\n\nBy default events service will infinitely try to reconnect in case of drop, you can monitor current state by subscribing to status updates:\n```js\nevents.status()\n .subscribe({ next: console.log });\n```\n\nIn case you need to terminate the connection you can do that (note that event service will start again in case you send a subscription request afterwards):\n```js\nawait events.stop();\n```\n\n## More examples\n\n### [Access BigMaps](https://baking-bad.org/blog/2021/04/28/tzkt-v15-released-with-bigmaps-and-florence-support/)\n\nPlease refer to an article on [BigMaps indexing](https://baking-bad.org/blog/2021/04/28/tzkt-v15-released-with-bigmaps-and-florence-support/#full-fledged-bigmaps) for a more detailed explanation on what these requests allow you to achieve.\n\n#### Accessing [BigMap by Ptr](https://baking-bad.org/blog/2021/04/28/tzkt-v15-released-with-bigmaps-and-florence-support/#access-bigmaps)\n\n```ts\nimport { bigMapsGetBigMapById } from '@tzkt/sdk-api'\n\nconst bigMapPtr = 543\n\nawait bigMapsGetBigMapById(bigMapPtr)\n```\n\n#### Accessing [BigMap by the path in the contract storage](https://baking-bad.org/blog/2021/04/28/tzkt-v15-released-with-bigmaps-and-florence-support/#example-2)\n\n```ts\nimport { contractsGetBigMapByName } from '@tzkt/sdk-api'\n\nconst contractAddress = 'KT1TtaMcoSx5cZrvaVBWsFoeZ1L15cxo5AEy'\nconst pathToBigMap = 'ledger'\n\nawait contractsGetBigMapByName(\n contractAddress,\n pathToBigMap\n)\n```\n\n#### Accessing [BigMap keys](https://baking-bad.org/blog/2021/04/28/tzkt-v15-released-with-bigmaps-and-florence-support/#get-all-bigmap-keys)\n\n```ts\nimport { bigMapsGetKeys } from '@tzkt/sdk-api'\n\nconst bigMapId = 511\nconst limit = 10\n\nawait bigMapsGetKeys(\n bigMapId,\n { limit }\n)\n```\n\n#### Accessing [All owners of NFT with non-zero balance](https://baking-bad.org/blog/2021/04/28/tzkt-v15-released-with-bigmaps-and-florence-support/#how-to-get-current-owners-with-balance-0-of-that-nft)\n\n```ts\nimport { bigMapsGetKeys } from '@tzkt/sdk-api'\n\nconst bigMapId = 511\nconst key = {\n value: 154,\n path: 'nat'\n}\nconst minValue = 0\n\nawait bigMapsGetKeys(\n bigMapId,\n {\n key: {\n eq: {\n jsonValue: `${key.value}`,\n jsonPath: key.path\n }\n },\n value: {\n gt: {\n jsonValue: `${minValue}`\n }\n }\n }\n)\n```\n\n#### Accessing [all updates of all BigMaps of a specific contract](https://baking-bad.org/blog/2021/04/28/tzkt-v15-released-with-bigmaps-and-florence-support/#bigmap-updates)\n\n```ts\nimport { bigMapsGetBigMapUpdates } from '@tzkt/sdk-api'\n\nconst contract = 'KT1K9gCRgaLRFKTErYt1wVxA3Frb9FjasjTV'\nawait bigMapsGetBigMapUpdates({\n contract: {\n eq: contract\n }\n})\n```\n\n### [Accessing Tokens API](https://baking-bad.org/blog/2022/01/11/tzkt-v17-with-generic-token-indexing-released/)\n\nPlease refer to an article on [Tokens indexing](https://baking-bad.org/blog/2022/01/11/tzkt-v17-with-generic-token-indexing-released/) for a more detailed explanation on what these requests allow you to achieve.\n\n#### Accessing [tokens transfers with deep fields selection](https://baking-bad.org/blog/2022/01/11/tzkt-v17-with-generic-token-indexing-released/#deep-selecting)\n\n```ts\nimport { tokensGetTokenTransfers } from '@tzkt/sdk-api'\n\nconst tokenId = 778919\nconst limit = 2\nconst sort = 'id'\nconst fields = [\n 'from.address',\n 'to.address',\n 'amount',\n 'token.metadata.symbol',\n 'token.metadata.decimals'\n]\n\nawait tokensGetTokenTransfers({\n tokenId: {\n eq: tokenId\n },\n sort: {\n desc: sort\n },\n limit,\n select: {\n fields\n }\n})\n```\n\n#### Accessing [FA1.2 tokens with the largest number of holders](https://baking-bad.org/blog/2022/01/11/tzkt-v17-with-generic-token-indexing-released/#examples-of-the-v1-tokens-endpoint-usage)\n\n```ts\nimport { tokensGetTokens } from '@tzkt/sdk-api'\n\nconst standard = 'fa1.2'\nconst sort = 'holdersCount'\nconst limit = 10\n\nconst r = await tokensGetTokens({\n standard: {\n eq: standard\n },\n sort: {\n desc: sort\n },\n limit\n})\n```\n\n#### Accessing [all account's NFTs](https://baking-bad.org/blog/2022/01/11/tzkt-v17-with-generic-token-indexing-released/#examples-of-the-v1-tokens-balances-endpoint-usage)\n\n```ts\nimport { tokensGetTokenBalances } from '@tzkt/sdk-api'\n\nconst account = 'tz1SLgrDBpFWjGCnCwyNpCpQC1v8v2N8M2Ks'\nconst minBalance = 0\nconst symbol = 'OBJKT'\nconst limit = 10\n\nconst r = await tokensGetTokenBalances({\n account: {\n eq: account\n },\n balance: {\n ne: `${minBalance}`\n },\n tokenMetadata: {\n eq: {\n jsonPath: 'symbol',\n jsonValue: symbol\n }\n },\n limit\n})\n```\n\n#### Accessing [whale transfers of a token](https://baking-bad.org/blog/2022/01/11/tzkt-v17-with-generic-token-indexing-released/#examples-of-the-v1-tokens-transfers-endpoint-usage)\n\n```ts\nimport { tokensGetTokenTransfers } from '@tzkt/sdk-api'\n\nconst tokenId = 85\nconst minAmount = '100000000000000000000000'\nconst sort = 'id'\nconst limit = 10\n\nconst r = await tokensGetTokenTransfers({\n tokenId: {\n eq: tokenId\n },\n amount: {\n gt: minAmount\n },\n sort: {\n desc: sort\n },\n limit\n})\n```\n\n#### Accessing [\"mints\" of a token](https://baking-bad.org/blog/2022/01/11/tzkt-v17-with-generic-token-indexing-released/#examples-of-the-v1-tokens-transfers-endpoint-usage)\n\n```ts\nimport { tokensGetTokenTransfers } from '@tzkt/sdk-api'\n\nconst tokenId = 85\nconst sort = 'id'\nconst limit = 10\n\nconst r = await tokensGetTokenTransfers({\n tokenId: {\n eq: tokenId\n },\n from: {\n null: true\n },\n sort: {\n desc: sort\n },\n limit\n})\n```\n\n### [Accessing Transactions](https://baking-bad.org/blog/2021/03/03/tzkt-v14-released-with-improved-smart-contract-data-and-websocket-api/#filter-transactions-by-parameter-like-a-boss)\n\nPlease refer to an article on [Transactions querying](https://baking-bad.org/blog/2021/03/03/tzkt-v14-released-with-improved-smart-contract-data-and-websocket-api/#filter-transactions-by-parameter-like-a-boss) for a more detailed explanation on what these requests allow you to achieve.\n\n#### Accessing [incoming transfers for the account](https://baking-bad.org/blog/2021/03/03/tzkt-v14-released-with-improved-smart-contract-data-and-websocket-api/#filter-transactions-by-parameter-like-a-boss)\n\n```ts\nimport { operationsGetTransactions } from '@tzkt/sdk-api'\n\nconst target = 'KT1K9gCRgaLRFKTErYt1wVxA3Frb9FjasjTV'\nconst parameter = {\n path: 'to',\n value: 'tz1aKTCbAUuea2RV9kxqRVRg3HT7f1RKnp6a'\n}\n\nconst r = await operationsGetTransactions({\n target: {\n eq: target\n },\n parameter: {\n eq: {\n jsonPath: parameter.path,\n jsonValue: parameter.value\n }\n }\n})\n```\n\n#### Accessing [Dexter XTZ to USDtz trades with specified amount](https://baking-bad.org/blog/2021/03/03/tzkt-v14-released-with-improved-smart-contract-data-and-websocket-api/#filter-transactions-by-parameter-like-a-boss)\n\n```ts\nimport { operationsGetTransactions } from '@tzkt/sdk-api'\n\nconst target = 'KT1K9gCRgaLRFKTErYt1wVxA3Frb9FjasjTV'\nconst parameter = {\n path: 'to',\n value: 'tz1aKTCbAUuea2RV9kxqRVRg3HT7f1RKnp6a'\n}\n\nconst r = await operationsGetTransactions({\n target: {\n eq: target\n },\n parameter: {\n eq: {\n jsonPath: parameter.path,\n jsonValue: parameter.value\n }\n }\n})\n```\n\n#### Accessing [Atomex atomic swaps with specified refund time](https://baking-bad.org/blog/2021/03/03/tzkt-v14-released-with-improved-smart-contract-data-and-websocket-api/#filter-transactions-by-parameter-like-a-boss)\n\n```ts\nimport { operationsGetTransactions } from '@tzkt/sdk-api'\n\nconst target = 'KT1VG2WtYdSWz5E7chTeAdDPZNy2MpP8pTfL'\nconst filterField = 'settings.refund_time'\nconst timeFrame = '2021-02-*'\n\nconst r = await operationsGetTransactions({\n target: {\n eq: target\n },\n parameter: {\n as: {\n jsonPath: filterField,\n jsonValue: timeFrame\n }\n }\n})\n```\n\n#### Accessing [Dexter wXTZ/XTZ trades](https://baking-bad.org/blog/2021/03/03/tzkt-v14-released-with-improved-smart-contract-data-and-websocket-api/#filter-transactions-by-parameter-like-a-boss)\n\n```ts\nimport { operationsGetTransactions } from '@tzkt/sdk-api'\n\nconst target = 'KT1D56HQfMmwdopmFLTwNHFJSs6Dsg2didFo'\nconst entrypoints = ['xtzToToken', 'tokenToXtz', 'tokenToToken']\n\nconst r = await operationsGetTransactions({\n target: {\n eq: target\n },\n entrypoint: {\n in: entrypoints\n }\n})\n```\n\n#### Accessing [operations with tzBTC related to a specific account](https://baking-bad.org/blog/2021/03/03/tzkt-v14-released-with-improved-smart-contract-data-and-websocket-api/#filter-transactions-by-parameter-like-a-boss)\n\n```ts\nimport { operationsGetTransactions } from '@tzkt/sdk-api'\n\nconst target = 'KT1PWx2mnDueood7fEmfbBDKx1D9BAnnXitn'\nconst entrypoints = ['mint', 'transfer', 'burn']\nconst parameter = '*tz1aKTCbAUuea2RV9kxqRVRg3HT7f1RKnp6a*'\n\nconst r = await operationsGetTransactions({\n target: {\n eq: target\n },\n entrypoint: {\n in: entrypoints\n },\n parameter: {\n as: {\n jsonValue: parameter\n }\n }\n})\n```", "x-tagGroup": "sdk" }, { "name": "Taquito extension", "description": "TzKT extension for the [Taquito](https://tezostaquito.io/) library can significantly speed up your application by reducing the number of requests made to a Tezos node. Instead, most of the queries are routed through TzKT API which is much more scalable. The best thing is that you don't have to change anything in your code (almost).\n\n## Installation\n\n```\nnpm i @tzkt/ext-taquito\n```\n\n## Usage\n\nIn order to enable routing enable the TzKT extension per each `TezosToolkit` instance created:\n\n```\nimport { TezosToolkit } from '@taquito/taquito';\nimport { TzktExtension } from '@tzkt/ext-taquito';\n\nconst Tezos = new TezosToolkit('https://rpc.tzkt.io/mainnet');\nTezos.addExtension(new TzktExtension());\n```\n\nTzKT extension will route the following requests:\n- `getEntrypoints`\n- `getScript`\n- `getBalance`\n- `getDelegate`\n- `getNextProtocol`\n- `getProtocolConstants`\n- `getStorage`\n- `getBlockHash`\n- `getBlockLevel`\n- `getCounter`\n- `getBlockTimestamp`\n- `getBigMapValue`\n- `isAccountRevealed`\n- `getLiveBlocks`\n\nAll other requests will be executed against the specified node URI, as usual.\n\n### Changing API endpoint\n\nYou may override base URL used by the package in the following manner. This may come useful should you want to make requests to a test network or to your custom server.\n\n```\nTezos.addExtension(new TzktExtension({url: 'https://api.tzkt.io'}));\n```", "x-tagGroup": "sdk" } ], "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" ] } ] }