{ "schemes": [], "swagger": "2.0", "info": { "description": "TON Index collects data from a full node to PostgreSQL database and provides convenient API to an indexed blockchain.", "title": "TON Index (Go)", "contact": {}, "version": "1.2.6" }, "host": "", "basePath": "", "paths": { "/api/v3/accountStates": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Query account states", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounts" ], "summary": "Get Account States", "operationId": "api_v3_get_account_states", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "List of addresses in any form. Maximum 1000 addresses allowed.", "name": "address", "in": "query", "required": true }, { "type": "boolean", "default": true, "description": "Include code and data BOCs. Default: true", "name": "include_boc", "in": "query" }, { "type": "boolean", "default": false, "description": "Decode each account's data cell with its catalog ABI. Default: false", "name": "include_storage", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AccountStatesResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/actions": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get actions by specified filter.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "actions" ], "summary": "Get Actions", "operationId": "api_v3_get_actions", "parameters": [ { "type": "string", "description": "List of account addresses to get actions. Can be sent in hex, base64 or base64url form.", "name": "account", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Find actions by transaction hash.", "name": "tx_hash", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Find actions by message hash.", "name": "msg_hash", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Find actions by the action_id.", "name": "action_id", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Find actions by the trace_id.", "name": "trace_id", "in": "query" }, { "type": "integer", "format": "int32", "description": "Query actions of traces which was completed in masterchain block with given seqno", "name": "mc_seqno", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "description": "Query actions for traces with `trace_end_utime \u003e= start_utime`.", "name": "start_utime", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "description": "Query actions for traces with `trace_end_utime \u003c= end_utime`.", "name": "end_utime", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int64", "description": "Query actions for traces with `trace_end_lt \u003e= start_lt`.", "name": "start_lt", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int64", "description": "Query actions for traces with `trace_end_lt \u003c= end_lt`.", "name": "end_lt", "in": "query" }, { "type": "array", "items": { "enum": [ "call_contract", "contract_deploy", "ton_transfer", "auction_bid", "change_dns", "dex_deposit_liquidity", "dex_withdraw_liquidity", "delete_dns", "renew_dns", "election_deposit", "election_recover", "jetton_burn", "jetton_swap", "jetton_transfer", "jetton_mint", "nft_mint", "tick_tock", "stake_deposit", "stake_withdrawal", "stake_withdrawal_request", "subscribe", "unsubscribe" ], "type": "string" }, "collectionFormat": "multi", "description": "Include action types.", "name": "action_type", "in": "query" }, { "type": "array", "items": { "enum": [ "call_contract", "contract_deploy", "ton_transfer", "auction_bid", "change_dns", "dex_deposit_liquidity", "dex_withdraw_liquidity", "delete_dns", "renew_dns", "election_deposit", "election_recover", "jetton_burn", "jetton_swap", "jetton_transfer", "jetton_mint", "nft_mint", "tick_tock", "stake_deposit", "stake_withdrawal", "stake_withdrawal_request", "subscribe", "unsubscribe" ], "type": "string" }, "collectionFormat": "multi", "description": "Exclude action types.", "name": "exclude_action_type", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Supported action types", "name": "supported_action_types", "in": "query" }, { "type": "boolean", "default": false, "description": "Include accounts array for each action in response.", "name": "include_accounts", "in": "query" }, { "type": "boolean", "default": false, "description": "Include `transactions_full` array with detailed transaction data for each action in response.", "name": "include_transactions", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. Use with *offset* to batch read.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Skip first N rows. Use with *limit* to batch read.", "name": "offset", "in": "query" }, { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "description": "Sort actions by lt.", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ActionsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/acton/contracts": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Without a selector this is the entire pinned catalog without type tables. With code_hash or catalog_id it is the matching entries, each carrying its full compiler ABI. Results are deduplicated and keep selector order; unknown selectors match nothing. Identification is bytecode-hash matching, not source verification.", "produces": [ "application/json" ], "tags": [ "acton" ], "summary": "List Acton contracts", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Code hashes; at most 50 selectors in total", "name": "code_hash", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Catalog IDs; at most 50 selectors in total", "name": "catalog_id", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "description": "Page size; the whole result by default", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "default": 0, "description": "Rows to skip", "name": "offset", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ActonContractsResponse" } }, "413": { "description": "Request Entity Too Large", "schema": { "$ref": "#/definitions/models.IndexError" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/models.IndexError" } } } } }, "/api/v3/acton/decode": { "post": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Select exactly one catalog_id or code_hash. Direction is storage, deployment_storage, incoming_messages, incoming_external, outgoing_messages, or emitted_events.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "acton" ], "summary": "Decode Acton storage or message body", "parameters": [ { "description": "Explicit ABI selector and BOC", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ActonDecodeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ActonDecodeResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/models.IndexError" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/models.IndexError" } } } } }, "/api/v3/acton/runGetMethod": { "post": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Requires a positive seqno or resolves it once. Reads account code and executes runGetMethodStd at the same seqno; library code and implementation hashes stay distinct. The ABI is the catalog entry declaring the named getter for that code, so the request selects no ABI of its own. Pinning trusts the configured upstream, not a proof. VM and decoding failures retain raw stack, gas and exit code.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "acton" ], "summary": "Run and decode a pinned Acton getter", "parameters": [ { "description": "Address, getter name or numeric TVM ID, named args, optional seqno", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ActonRunRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ActonRunResponse" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/models.IndexError" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/models.IndexError" } }, "502": { "description": "Bad Gateway", "schema": { "$ref": "#/definitions/models.IndexError" } } } } }, "/api/v3/addressBook": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Query address book", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounts" ], "summary": "Address Book", "operationId": "api_v3_get_address_book", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "List of addresses in any form to get address book. Max: 1024.", "name": "address", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GenericAddressBook" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/addressInformation": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get smart contract information.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "api/v2" ], "summary": "Get Address Information", "operationId": "api_v3_get_v2_addressInformation", "parameters": [ { "type": "string", "description": "Account address in any form.", "name": "address", "in": "query", "required": true }, { "type": "boolean", "default": true, "description": "Use method from api/v2. Not recommended", "name": "use_v2", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/V2AddressInformation" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/adjacentTransactions": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get parent and/or children for specified transaction.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "blockchain" ], "summary": "Get Adjacent Transactions", "operationId": "api_v3_get_adjacent_transactions", "parameters": [ { "type": "string", "description": "Transaction hash.", "name": "hash", "in": "query" }, { "enum": [ "in", "out" ], "type": "string", "description": "Direction of message.", "name": "direction", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TransactionsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/blocks": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Returns blocks by specified filters.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "blockchain" ], "summary": "Get blocks", "operationId": "api_v3_get_blocks", "parameters": [ { "type": "integer", "format": "int32", "description": "Block workchain.", "name": "workchain", "in": "query" }, { "type": "string", "description": "Block shard id. Must be sent with *workchain*. Example: `8000000000000000`.", "name": "shard", "in": "query" }, { "type": "integer", "format": "int32", "description": "Block block seqno. Must be sent with *workchain* and *shard*.", "name": "seqno", "in": "query" }, { "type": "string", "description": "Block root hash.", "name": "root_hash", "in": "query" }, { "type": "string", "description": "Block file hash.", "name": "file_hash", "in": "query" }, { "type": "integer", "format": "int32", "description": "Masterchain block seqno", "name": "mc_seqno", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "description": "Query blocks with generation UTC timestamp **after** given timestamp.", "name": "start_utime", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "description": "Query blocks with generation UTC timestamp **before** given timestamp.", "name": "end_utime", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int64", "description": "Query blocks with `lt \u003e= start_lt`.", "name": "start_lt", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int64", "description": "Query blocks with `lt \u003c= end_lt`.", "name": "end_lt", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. Use with *offset* to batch read.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Skip first N rows. Use with *limit* to batch read.", "name": "offset", "in": "query" }, { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "description": "Sort results by UTC timestamp.", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BlocksResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/decode": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Decode opcodes and message bodies. Opcodes can be in hex (with or without 0x prefix) or decimal format. Bodies should be in base64 or hex format.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "utils" ], "summary": "Decode Opcodes and Bodies", "operationId": "api_v3_get_decode", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "List of opcodes to decode (hex or decimal)", "name": "opcodes", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "List of message bodies to decode (base64 or hex)", "name": "bodies", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DecodeResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } }, "post": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Decode opcodes and message bodies. Opcodes can be in hex (with or without 0x prefix) or decimal format. Bodies should be in base64 or hex format. Use POST method for long parameters that may be truncated in GET requests.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "utils" ], "summary": "Decode Opcodes and Bodies", "operationId": "api_v3_post_decode", "parameters": [ { "description": "Decode request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DecodeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DecodeResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/dns/activeAuctions": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Returns DNS auctions where the address is the current leading bidder.\nUse `bidding` for open auctions and `won` for ended but unclaimed auctions.\nClaimed auctions are no longer returned.\nOrdering for *bidding* and *all* can change between pages as auctions update; prefer larger limits.\nSet *include_nft_items* to include NFT details. Available NFT and collection metadata is returned separately.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "dns" ], "summary": "Get DNS Auctions by Bidder", "operationId": "api_v3_get_dns_active_auctions", "parameters": [ { "type": "string", "description": "Address of the current leading bidder.", "name": "bidder", "in": "query", "required": true }, { "enum": [ "all", "won", "bidding" ], "type": "string", "default": "all", "description": "Filter by auction state.", "name": "state", "in": "query" }, { "type": "boolean", "default": false, "description": "Include NFT item details.", "name": "include_nft_items", "in": "query" }, { "type": "string", "description": "Opaque pagination cursor from *next_cursor* of the previous page. Returns rows strictly after it; preferred over *offset*.", "name": "after", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 100, "description": "Maximum rows to return.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Rows to skip. Not allowed together with *after*.", "name": "offset", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DNSAuctionsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/dns/records": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Query DNS records by specified filters. Currently .ton and .t.me DNS are supported.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "dns" ], "summary": "Get DNS Records", "operationId": "api_v3_get_dns_records", "parameters": [ { "type": "string", "description": "Wallet address in any form. DNS records that contain this address in wallet category will be returned.", "name": "wallet", "in": "query" }, { "type": "string", "description": "Domain name to search for. DNS records with this exact domain name will be returned.", "name": "domain", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 100, "description": "Limit number of queried rows. Use with *offset* to batch read.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Skip first N rows. Use with *limit* to batch read.", "name": "offset", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DNSRecordsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/estimateFee": { "post": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Estimate fees required for query processing. Fields body, init-code and init-data accepted in serialized format (b64-encoded).", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "api/v2" ], "summary": "Estimate Fee", "operationId": "api_v3_post_v2_estimate_fee", "parameters": [ { "description": "Estimate fee request.", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/V2EstimateFeeRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/V2EstimateFeeResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/jetton/burns": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get Jetton burns by specified filters", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "jettons" ], "summary": "Get Jetton Burns", "operationId": "api_v3_get_jetton_burns", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Address of jetton wallet owner in any form. Max 1000", "name": "address", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Jetton wallet address in any form. Max: 1000.", "name": "jetton_wallet", "in": "query" }, { "type": "string", "description": "Jetton master address in any form.", "name": "jetton_master", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "description": "Query transactions with generation UTC timestamp **after** given timestamp.", "name": "start_utime", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "description": "Query transactions with generation UTC timestamp **before** given timestamp.", "name": "end_utime", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int64", "description": "Query transactions with `lt \u003e= start_lt`.", "name": "start_lt", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int64", "description": "Query transactions with `lt \u003c= end_lt`.", "name": "end_lt", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. Use with *offset* to batch read.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Skip first N rows. Use with *limit* to batch read.", "name": "offset", "in": "query" }, { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "description": "Sort transactions by lt.", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/JettonBurnsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/jetton/masters": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get Jetton masters by specified filters", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "jettons" ], "summary": "Get Jetton Masters", "operationId": "api_v3_get_jetton_masters", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Jetton Master address in any form. Max: 1024.", "name": "address", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Address of Jetton Master's admin in any form. Max: 1024.", "name": "admin_address", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. Use with *offset* to batch read.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Skip first N rows. Use with *limit* to batch read.", "name": "offset", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/JettonMastersResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/jetton/transfers": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get Jetton transfers by specified filters", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "jettons" ], "summary": "Get Jetton Transfers", "operationId": "api_v3_get_jetton_transfers", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Address of jetton wallet owner in any form. Max 1000", "name": "owner_address", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Jetton wallet address in any form. Max: 1000.", "name": "jetton_wallet", "in": "query" }, { "type": "string", "description": "Jetton master address in any form.", "name": "jetton_master", "in": "query" }, { "enum": [ "in", "out" ], "type": "string", "description": "Direction of transfer. *Note:* applied only with owner_address.", "name": "direction", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "description": "Query transactions with generation UTC timestamp **after** given timestamp.", "name": "start_utime", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "description": "Query transactions with generation UTC timestamp **before** given timestamp.", "name": "end_utime", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int64", "description": "Query transactions with `lt \u003e= start_lt`.", "name": "start_lt", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int64", "description": "Query transactions with `lt \u003c= end_lt`.", "name": "end_lt", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. Use with *offset* to batch read.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Skip first N rows. Use with *limit* to batch read.", "name": "offset", "in": "query" }, { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "description": "Sort transactions by lt.", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/JettonTransfersResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/jetton/wallets": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get Jetton wallets by specified filters", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "jettons" ], "summary": "Get Jetton Wallets", "operationId": "api_v3_get_jetton_wallets", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Jetton wallet address in any form. Max: 1000.", "name": "address", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Address of Jetton wallet's owner in any form. Max: 1000.", "name": "owner_address", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Jetton Master in any form.", "name": "jetton_address", "in": "query" }, { "type": "boolean", "description": "Exclude jetton wallets with 0 balance.", "name": "exclude_zero_balance", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. Use with *offset* to batch read.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Skip first N rows. Use with *limit* to batch read.", "name": "offset", "in": "query" }, { "enum": [ "asc", "desc" ], "type": "string", "description": "Sort jetton wallets by balance. **Warning:** results may be inconsistent during the read with limit and offset.", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/JettonWalletsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/masterchainBlockShardState": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get masterchain block shard state. Same as /api/v2/shards.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "blockchain" ], "summary": "Get masterchain block shard state", "operationId": "api_v3_get_masterchainBlockShardState", "parameters": [ { "type": "integer", "format": "int32", "description": "Masterchain block seqno.", "name": "seqno", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TransactionsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/masterchainBlockShards": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Returns all worchain blocks, that appeared after previous masterchain block.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "blockchain" ], "summary": "Get masterchain block shard state", "operationId": "api_v3_get_masterchainBlockShards", "parameters": [ { "type": "integer", "format": "int32", "description": "Masterchain block seqno.", "name": "seqno", "in": "query", "required": true }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. Use with *offset* to batch read.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Skip first N rows. Use with *limit* to batch read.", "name": "offset", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TransactionsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/masterchainInfo": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get first and last indexed block", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "blockchain" ], "summary": "Get Masterchain Info", "operationId": "api_v3_get_masterchain_info", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MasterchainInfo" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/message": { "post": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Send an external message to the TON network.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "api/v2" ], "summary": "Send Message", "operationId": "api_v3_post_v2_message", "parameters": [ { "description": "Message in boc base64 format.", "name": "boc", "in": "body", "required": true, "schema": { "$ref": "#/definitions/V2SendMessageRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/V2SendMessageResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/messages": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get messages by specified filters.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "blockchain" ], "summary": "Get messages", "operationId": "api_v3_get_messages", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Message hash. Acceptable in hex, base64 and base64url forms.", "name": "msg_hash", "in": "query" }, { "type": "string", "description": "Hash of message body.", "name": "body_hash", "in": "query" }, { "type": "string", "description": "The source account address. Can be sent in hex, base64 or base64url form. Use value `null` to get external messages.", "name": "source", "in": "query" }, { "type": "string", "description": "The destination account address. Can be sent in hex, base64 or base64url form. Use value `null` to get log messages.", "name": "destination", "in": "query" }, { "type": "string", "description": "Opcode of message in hex or signed 32-bit decimal form.", "name": "opcode", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "description": "Query messages with `created_at \u003e= start_utime`.", "name": "start_utime", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "description": "Query messages with `created_at \u003e= start_utime`.", "name": "end_utime", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int64", "description": "Query messages with `created_lt \u003e= start_lt`.", "name": "start_lt", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int64", "description": "Query messages with `created_lt \u003c= end_lt`.", "name": "end_lt", "in": "query" }, { "enum": [ "in", "out" ], "type": "string", "description": "Direction of message.", "name": "direction", "in": "query" }, { "type": "boolean", "description": "Exclude external messages.", "name": "exclude_externals", "in": "query" }, { "type": "boolean", "description": "Return only external messages.", "name": "only_externals", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. Use with *offset* to batch read.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Skip first N rows. Use with *limit* to batch read.", "name": "offset", "in": "query" }, { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "description": "Sort messages by effective LT: `created_lt` for internal/external-out messages and the receiving transaction LT for external-in messages.", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MessagesResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/metadata": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Query address metadata", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounts" ], "summary": "Metadata", "operationId": "api_v3_get_metadata", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "List of addresses in any form to get address metadata. Max: 1024.", "name": "address", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Metadata" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/multisig/orders": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get multisig orders by specified filters", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "multisig" ], "summary": "Get Multisig Orders", "operationId": "api_v3_get_multisig_orders", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Order address in any form. Max: 1024.", "name": "address", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Address of corresponding multisig. Max: 1024.", "name": "multisig_address", "in": "query" }, { "type": "boolean", "default": false, "description": "Parser order actions", "name": "parse_actions", "in": "query" }, { "maximum": 1024, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. Use with *offset* to batch read.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Skip first N rows. Use with *limit* to batch read.", "name": "offset", "in": "query" }, { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "description": "Sort orders by last_transaction_lt.", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MultisigOrderResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/multisig/wallets": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get multisig contracts by specified filters with associated orders", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "multisig" ], "summary": "Get Multisigs", "operationId": "api_v3_get_multisig_wallets", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Multisig contract address in any form. Max: 1024.", "name": "address", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Address of signer or proposer wallet in any form. Max: 1024.", "name": "wallet_address", "in": "query" }, { "maximum": 1024, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. Use with *offset* to batch read.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Skip first N rows. Use with *limit* to batch read.", "name": "offset", "in": "query" }, { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "description": "Sort multisigs by last_transaction_lt.", "name": "sort", "in": "query" }, { "type": "boolean", "default": true, "description": "Gather multisig orders", "name": "include_orders", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MultisigResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/nft/collections": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get NFT collections by specified filters", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "nfts" ], "summary": "Get NFT collections", "operationId": "api_v3_get_nft_collections", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Collection address in any form. Max: 1024.", "name": "collection_address", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Address of collection owner in any form. Max: 1024.", "name": "owner_address", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. Use with *offset* to batch read.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Skip first N rows. Use with *limit* to batch read.", "name": "offset", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NFTCollectionsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/nft/items": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get NFT items by specified filters", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "nfts" ], "summary": "Get NFT items", "operationId": "api_v3_get_nft_items", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "NFT item address in any form. Max: 1000.", "name": "address", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Address of NFT item owner in any form. Max: 1000.", "name": "owner_address", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Collection address in any form.", "name": "collection_address", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Index of item for given collection. Max: 1000.", "name": "index", "in": "query" }, { "type": "boolean", "default": false, "description": "Include nft on sales and auctions. Used only when owner_address is passed", "name": "include_on_sale", "in": "query" }, { "type": "boolean", "description": "Sort NFT items by last transaction lt descending. **Warning:** results may be inconsistent during pagination with limit and offset.", "name": "sort_by_last_transaction_lt", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. Use with *offset* to batch read.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Skip first N rows. Use with *limit* to batch read.", "name": "offset", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NFTItemsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/nft/sales": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get GetGems NFT sales and auctions by sale/auction contract addresses", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "nfts" ], "summary": "Get NFT Sales and Auctions", "operationId": "api_v3_get_nft_sales", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Sale or auction contract address in any form. Max: 1000.", "name": "address", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NFTSalesResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/nft/transfers": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get transfers of NFT items by specified filters", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "nfts" ], "summary": "Get NFT Transfers", "operationId": "api_v3_get_nft_transfers", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Address of NFT owner in any form. Max 1000", "name": "owner_address", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Address of NFT item in any form. Max: 1000.", "name": "item_address", "in": "query" }, { "type": "string", "description": "Collection address in any form.", "name": "collection_address", "in": "query" }, { "enum": [ "in", "out" ], "type": "string", "description": "Direction of transfer.", "name": "direction", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "description": "Query transactions with generation UTC timestamp **after** given timestamp.", "name": "start_utime", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "description": "Query transactions with generation UTC timestamp **before** given timestamp.", "name": "end_utime", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int64", "description": "Query transactions with `lt \u003e= start_lt`.", "name": "start_lt", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int64", "description": "Query transactions with `lt \u003c= end_lt`.", "name": "end_lt", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. Use with *offset* to batch read.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Skip first N rows. Use with *limit* to batch read.", "name": "offset", "in": "query" }, { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "description": "Sort transactions by lt.", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NFTTransfersResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/pendingActions": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get actions by specified filter.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "actions" ], "summary": "Get Pending Actions", "operationId": "api_v3_get_pending_actions", "parameters": [ { "type": "string", "description": "List of account addresses to get actions. Can be sent in hex, base64 or base64url form.", "name": "account", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Find actions by trace external hash", "name": "ext_msg_hash", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Supported action types", "name": "supported_action_types", "in": "query" }, { "type": "boolean", "default": false, "description": "Include `transactions_full` array with detailed transaction data for each action in response.", "name": "include_transactions", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ActionsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/pendingTraces": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get traces by specified filter.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "actions" ], "summary": "Get Pending Traces", "operationId": "api_v3_get_pending_traces", "parameters": [ { "type": "string", "description": "List of account addresses to get transactions. Can be sent in hex, base64 or base64url form.", "name": "account", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Find trace by external hash", "name": "ext_msg_hash", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TracesResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/pendingTransactions": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get pending transactions by specified filter.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "blockchain" ], "summary": "Get pending transactions", "operationId": "api_v3_get_pending_transactions", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "List of account addresses to get transactions. Can be sent in hex, base64 or base64url form.", "name": "account", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Find transactions by trace id.", "name": "trace_id", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TransactionsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/runGetMethod": { "post": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Run get method of smart contract. Stack supports only `num`, `cell` and `slice` types:\n```\n[\n{\n\"type\": \"num\",\n\"value\": \"0x12a\"\n},\n{\n\"type\": \"cell\",\n\"value\": \"te6...\" // base64 encoded boc with cell\n},\n{\n\"type\": \"slice\",\n\"value\": \"te6...\" // base64 encoded boc with slice\n}\n]\n```", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "api/v2" ], "summary": "Run Get-Method", "operationId": "api_v3_post_v2_rungetmethod", "parameters": [ { "description": "Run Get-method request", "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/V2RunGetMethodRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/V2RunGetMethodRequest" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/staking/nominatorPools/nominator": { "get": { "produces": [ "application/json" ], "tags": [ "staking" ], "summary": "Get nominator positions in nominator pools", "operationId": "getNominatorPoolNominator", "parameters": [ { "type": "string", "description": "Nominator address in any form", "name": "nominator", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NominatorPoolsResponse" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/models.IndexError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/models.IndexError" } } } } }, "/api/v3/staking/nominatorPools/nominatorEvents": { "get": { "produces": [ "application/json" ], "tags": [ "staking" ], "summary": "Get nominator events from nominator pools", "operationId": "getNominatorPoolNominatorEvents", "parameters": [ { "type": "string", "description": "Pool address in any form", "name": "pool", "in": "query", "required": true }, { "type": "string", "description": "Nominator address in any form", "name": "nominator", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Query events with timestamp at or after given timestamp.", "name": "start_utime", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Query events with timestamp at or before given timestamp.", "name": "end_utime", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 100, "description": "Limit number of queried rows.", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NominatorPoolEventsResponse" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/models.IndexError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/models.IndexError" } } } } }, "/api/v3/staking/nominatorPools/nominatorRewards": { "get": { "produces": [ "application/json" ], "tags": [ "staking" ], "summary": "Get nominator rewards from a nominator pool", "operationId": "getNominatorPoolNominatorRewards", "parameters": [ { "type": "string", "description": "Nominator address in any form", "name": "nominator", "in": "query", "required": true }, { "type": "string", "description": "Pool address in any form", "name": "pool", "in": "query", "required": true }, { "minimum": 0, "type": "integer", "description": "Query rewards with timestamp at or after given timestamp.", "name": "start_utime", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Query rewards with timestamp at or before given timestamp.", "name": "end_utime", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 100, "description": "Limit number of queried rows.", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NominatorRewardsResponse" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/models.IndexError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/models.IndexError" } } } } }, "/api/v3/staking/nominatorPools/pool": { "get": { "produces": [ "application/json" ], "tags": [ "staking" ], "summary": "Get nominator pool", "operationId": "getNominatorPool", "parameters": [ { "type": "string", "description": "Pool address in any form", "name": "pool", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NominatorPoolInfo" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/models.IndexError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/models.IndexError" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/models.IndexError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/models.IndexError" } } } } }, "/api/v3/staking/nominatorPools/validatorEvents": { "get": { "produces": [ "application/json" ], "tags": [ "staking" ], "summary": "Get validator accounting events from nominator pools", "operationId": "getNominatorPoolValidatorEvents", "parameters": [ { "type": "string", "description": "Validator address in any form", "name": "validator", "in": "query" }, { "type": "string", "description": "Pool address in any form", "name": "pool", "in": "query" }, { "type": "string", "description": "Event type", "name": "type", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Query events with timestamp at or after given timestamp.", "name": "start_utime", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Query events with timestamp at or before given timestamp.", "name": "end_utime", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 100, "description": "Limit number of queried rows.", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NominatorPoolValidatorEventsResponse" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/models.IndexError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/models.IndexError" } } } } }, "/api/v3/staking/nominatorPools/validatorRewards": { "get": { "produces": [ "application/json" ], "tags": [ "staking" ], "summary": "Get validator rewards from a nominator pool", "operationId": "getNominatorPoolValidatorRewards", "parameters": [ { "type": "string", "description": "Validator address in any form", "name": "validator", "in": "query", "required": true }, { "type": "string", "description": "Pool address in any form", "name": "pool", "in": "query", "required": true }, { "minimum": 0, "type": "integer", "description": "Query rewards with timestamp at or after given timestamp.", "name": "start_utime", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Query rewards with timestamp at or before given timestamp.", "name": "end_utime", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 100, "description": "Limit number of queried rows.", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/NominatorPoolValidatorRewardsResponse" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/models.IndexError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/models.IndexError" } } } } }, "/api/v3/topAccountsByBalance": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get list of accounts sorted descending by balance.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "stats" ], "summary": "Get Top Accounts By Balance", "operationId": "api_v3_get_top_accounts_by_balance", "parameters": [ { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. Use with *offset* to batch read.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Skip first N rows. Use with *limit* to batch read.", "name": "offset", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/AccountBalance" } } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/traces": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get traces by specified filter.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "actions" ], "summary": "Get Traces", "operationId": "api_v3_get_traces", "parameters": [ { "type": "string", "description": "List of account addresses to get transactions. Can be sent in hex, base64 or base64url form.", "name": "account", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Find trace by trace id.", "name": "trace_id", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Find trace by transaction hash.", "name": "tx_hash", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Find trace by message hash.", "name": "msg_hash", "in": "query" }, { "type": "integer", "format": "int32", "description": "Query traces that was completed in masterchain block with given seqno", "name": "mc_seqno", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "description": "Query traces, which was finished **after** given timestamp.", "name": "start_utime", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "description": "Query traces, which was finished **before** given timestamp.", "name": "end_utime", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int64", "description": "Query traces with `end_lt \u003e= start_lt`.", "name": "start_lt", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int64", "description": "Query traces with `end_lt \u003c= end_lt`.", "name": "end_lt", "in": "query" }, { "type": "boolean", "default": false, "description": "Include trace actions.", "name": "include_actions", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Supported action types", "name": "supported_action_types", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. Use with *offset* to batch read.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Skip first N rows. Use with *limit* to batch read.", "name": "offset", "in": "query" }, { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "description": "Sort traces by lt.", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TracesResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/transactions": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get transactions by specified filter.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "blockchain" ], "summary": "Get transactions", "operationId": "api_v3_get_transactions", "parameters": [ { "type": "integer", "format": "int32", "description": "Block workchain.", "name": "workchain", "in": "query" }, { "type": "string", "description": "Block shard id. Must be sent with *workchain*. Example: `8000000000000000`.", "name": "shard", "in": "query" }, { "type": "integer", "format": "int32", "description": "Block block seqno. Must be sent with *workchain* and *shard*.", "name": "seqno", "in": "query" }, { "type": "integer", "format": "int32", "description": "Masterchain block seqno.", "name": "mc_seqno", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "List of account addresses to get transactions. Can be sent in hex, base64 or base64url form.", "name": "account", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Exclude transactions on specified account addresses.", "name": "exclude_account", "in": "query" }, { "type": "string", "description": "Transaction hash.", "name": "hash", "in": "query" }, { "type": "integer", "format": "int64", "description": "Transaction lt.", "name": "lt", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "description": "Query transactions with generation UTC timestamp **after** given timestamp.", "name": "start_utime", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "description": "Query transactions with generation UTC timestamp **before** given timestamp.", "name": "end_utime", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int64", "description": "Query transactions with `lt \u003e= start_lt`.", "name": "start_lt", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int64", "description": "Query transactions with `lt \u003c= end_lt`.", "name": "end_lt", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. Use with *offset* to batch read.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Skip first N rows. Use with *limit* to batch read.", "name": "offset", "in": "query" }, { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "description": "Sort transactions by lt.", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TransactionsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/transactionsByMasterchainBlock": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Returns transactions from masterchain block and from all shards.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "blockchain" ], "summary": "Get transactions by Masterchain block", "operationId": "api_v3_get_transactions_by_masterchain_block", "parameters": [ { "type": "integer", "format": "int32", "description": "Masterchain block seqno.", "name": "seqno", "in": "query", "required": true }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. Use with *offset* to batch read.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Skip first N rows. Use with *limit* to batch read.", "name": "offset", "in": "query" }, { "enum": [ "asc", "desc" ], "type": "string", "default": "desc", "description": "Sort transactions by lt.", "name": "sort", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TransactionsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/transactionsByMessage": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get transactions whose inbound/outbound message has the specified hash. \\", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "blockchain" ], "summary": "Get transactions by message", "operationId": "api_v3_get_transactions_by_message", "parameters": [ { "type": "string", "description": "Message hash. Acceptable in hex, base64 and base64url forms.", "name": "msg_hash", "in": "query" }, { "type": "string", "description": "Hash of message body.", "name": "body_hash", "in": "query" }, { "type": "string", "description": "Opcode of message in hex or signed 32-bit decimal form.", "name": "opcode", "in": "query" }, { "enum": [ "in", "out" ], "type": "string", "description": "Direction of message.", "name": "direction", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. Use with *offset* to batch read.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Skip first N rows. Use with *limit* to batch read.", "name": "offset", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TransactionsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/validators/complaints": { "get": { "produces": [ "application/json" ], "tags": [ "validators" ], "summary": "Get validator complaints", "operationId": "getValidatorComplaints", "parameters": [ { "type": "integer", "description": "Validator cycle start time", "name": "cycle_start", "in": "query" }, { "type": "integer", "description": "Elector election id", "name": "election_id", "in": "query" }, { "type": "string", "description": "Stake holder address in any form", "name": "stake_holder_address", "in": "query" }, { "type": "string", "description": "ADNL address in hex, base64 or base64url form", "name": "adnl_address", "in": "query" }, { "type": "string", "description": "Validator public key in hex, base64 or base64url form", "name": "validator_pubkey", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Query complaints with created_at at or after given timestamp.", "name": "start_utime", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Query complaints with created_at at or before given timestamp.", "name": "end_utime", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows.", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ValidatorComplaintsResponse" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/models.IndexError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/models.IndexError" } } } } }, "/api/v3/validators/cycles": { "get": { "description": "Cycle `min_stake`/`max_stake` are selected validators' true stake bounds. `min_stake_limit`/`max_stake_limit` are config17 election limits. When validators are returned, each validator's `max_factor` is the participant's raw declared factor (65536 = 1.0); the effective factor used to derive `stake` is min(max_factor, cycle `max_stake_factor`).", "produces": [ "application/json" ], "tags": [ "validators" ], "summary": "Get validator cycles", "operationId": "getValidatorCycles", "parameters": [ { "type": "integer", "description": "Validator cycle start time", "name": "cycle_start", "in": "query" }, { "type": "integer", "description": "Elector election id that produced the cycle", "name": "election_id", "in": "query" }, { "type": "string", "description": "Stake holder address in any form", "name": "stake_holder_address", "in": "query" }, { "type": "string", "description": "ADNL address in hex, base64 or base64url form", "name": "adnl_address", "in": "query" }, { "type": "string", "description": "Validator public key in hex, base64 or base64url form", "name": "validator_pubkey", "in": "query" }, { "type": "boolean", "default": false, "description": "Return validators in the set. If stake_holder_address, adnl_address or validator_pubkey is specified, returns only matching validators.", "name": "return_validators", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Query cycles with cycle_start at or after given timestamp.", "name": "start_utime", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Query cycles with cycle_start at or before given timestamp.", "name": "end_utime", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. At most 100 when return_validators is true.", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ValidatorCyclesResponse" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/models.IndexError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/models.IndexError" } } } } }, "/api/v3/validators/elections": { "get": { "produces": [ "application/json" ], "tags": [ "validators" ], "summary": "Get validator elections", "operationId": "getValidatorElections", "parameters": [ { "type": "integer", "description": "Election id", "name": "election_id", "in": "query" }, { "type": "string", "description": "Stake holder address in any form", "name": "stake_holder_address", "in": "query" }, { "type": "string", "description": "ADNL address in hex, base64 or base64url form", "name": "adnl_address", "in": "query" }, { "type": "string", "description": "Validator public key in hex, base64 or base64url form", "name": "validator_pubkey", "in": "query" }, { "type": "boolean", "default": false, "description": "Return election participants. If stake_holder_address, adnl_address or validator_pubkey is specified, returns only matching participants.", "name": "return_participants", "in": "query" }, { "type": "boolean", "description": "Filter by finished flag", "name": "finished", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Query elections with election_id at or after given value. For elections, start_utime is applied to election_id, not elect_close.", "name": "start_utime", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Query elections with election_id at or before given value. For elections, end_utime is applied to election_id, not elect_close.", "name": "end_utime", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. At most 100 when return_participants is true.", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ValidatorElectionsResponse" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/models.IndexError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/models.IndexError" } } } } }, "/api/v3/validators/events": { "get": { "produces": [ "application/json" ], "tags": [ "validators" ], "summary": "Get validator stake/recover events", "operationId": "getValidatorEvents", "parameters": [ { "type": "string", "description": "Stake holder address in any form", "name": "stake_holder_address", "in": "query" }, { "type": "string", "description": "ADNL address in hex, base64 or base64url form", "name": "adnl_address", "in": "query" }, { "type": "string", "description": "Validator public key in hex, base64 or base64url form", "name": "validator_pubkey", "in": "query" }, { "enum": [ "stake_accepted", "stake_rejected", "stake_recovered" ], "type": "string", "description": "Event type", "name": "type", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Query events with timestamp at or after given timestamp.", "name": "start_utime", "in": "query" }, { "minimum": 0, "type": "integer", "description": "Query events with timestamp at or before given timestamp.", "name": "end_utime", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows.", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ValidatorEventsResponse" } }, "422": { "description": "Unprocessable Entity", "schema": { "$ref": "#/definitions/models.IndexError" } }, "500": { "description": "Internal Server Error", "schema": { "$ref": "#/definitions/models.IndexError" } } } } }, "/api/v3/vesting": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get vesting contracts by specified filters", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "vesting" ], "summary": "Get Vesting Contracts", "operationId": "api_v3_get_vesting_contracts", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Vesting contract address in any form. Max: 1000.", "name": "contract_address", "in": "query" }, { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "Wallet address to filter by owner or sender. Max: 1000.", "name": "wallet_address", "in": "query" }, { "type": "boolean", "default": false, "description": "Check if wallet address is in whitelist.", "name": "check_whitelist", "in": "query" }, { "maximum": 1000, "minimum": 1, "type": "integer", "format": "int32", "default": 10, "description": "Limit number of queried rows. Use with *offset* to batch read.", "name": "limit", "in": "query" }, { "minimum": 0, "type": "integer", "format": "int32", "default": 0, "description": "Skip first N rows. Use with *limit* to batch read.", "name": "offset", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VestingContractsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/walletInformation": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Get wallet smart contract information. The following wallets are supported: `v1r1`, `v1r2`, `v1r3`, `v2r1`, `v2r2`, `v3r1`, `v3r2`, `v4r1`, `v4r2`, `v5beta`, `v5r1`, `tg-wallet`. In case the account is not a wallet error code 409 is returned.", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "api/v2" ], "summary": "Get Wallet Information", "operationId": "api_v3_get_wallet_information", "parameters": [ { "type": "string", "description": "Account address in any form.", "name": "address", "in": "query", "required": true }, { "type": "boolean", "default": true, "description": "Use method from api/v2. Not recommended", "name": "use_v2", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/V2WalletInformation" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } }, "/api/v3/walletStates": { "get": { "security": [ { "APIKeyHeader": [] }, { "APIKeyQuery": [] } ], "description": "Query wallet information", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "accounts" ], "summary": "Get Wallet States", "operationId": "api_v3_get_wallet_states", "parameters": [ { "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "description": "List of addresses in any form. Maximum 1000 addresses allowed.", "name": "address", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/WalletStatesResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/RequestError" } } } } } }, "definitions": { "AccountBalance": { "type": "object", "properties": { "account": { "type": "string" }, "balance": { "type": "string" } } }, "AccountState": { "type": "object", "properties": { "account_status": { "type": "string" }, "balance": { "type": "string" }, "code_boc": { "type": "string" }, "code_hash": { "type": "string" }, "data_boc": { "type": "string" }, "data_hash": { "type": "string" }, "extra_currencies": { "type": "object", "additionalProperties": { "type": "string" } }, "frozen_hash": { "type": "string" }, "hash": { "type": "string" } } }, "AccountStateFull": { "type": "object", "properties": { "account_state_hash": { "type": "string" }, "address": { "type": "string" }, "balance": { "type": "string" }, "code_boc": { "type": "string" }, "code_hash": { "type": "string" }, "contract_methods": { "type": "array", "items": { "type": "integer" } }, "data_boc": { "type": "string" }, "data_hash": { "type": "string" }, "extra_currencies": { "type": "object", "additionalProperties": { "type": "string" } }, "frozen_hash": { "type": "string" }, "interfaces": { "type": "array", "items": { "type": "string" } }, "last_transaction_hash": { "type": "string" }, "last_transaction_lt": { "type": "string", "example": "0" }, "status": { "type": "string" }, "storage": { "description": "Storage is the data cell decoded with the catalog entry the response's\ncode_book names first for this code, requested with include_storage.", "type": "object" }, "storage_error": { "type": "string" }, "suspended": { "type": "boolean" } } }, "AccountStatesResponse": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "$ref": "#/definitions/AccountStateFull" } }, "address_book": { "$ref": "#/definitions/AddressBook" }, "code_book": { "$ref": "#/definitions/CodeBook" }, "metadata": { "$ref": "#/definitions/Metadata" } } }, "Action": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "type": "string" } }, "action_id": { "type": "string" }, "details": {}, "end_lt": { "type": "string", "example": "0" }, "end_utime": { "type": "integer" }, "finality": { "$ref": "#/definitions/models.FinalityState" }, "parent_gasless_action": { "description": "action_id of the gasless_request action this action is an immediate result of", "type": "string" }, "start_lt": { "type": "string", "example": "0" }, "start_utime": { "type": "integer" }, "success": { "type": "boolean" }, "trace_end_lt": { "type": "string", "example": "0" }, "trace_end_utime": { "type": "integer" }, "trace_external_hash": { "type": "string" }, "trace_external_hash_norm": { "type": "string" }, "trace_id": { "type": "string" }, "trace_mc_seqno_end": { "type": "integer" }, "transactions": { "type": "array", "items": { "type": "string" } }, "transactions_full": { "type": "array", "items": { "$ref": "#/definitions/Transaction" } }, "type": { "type": "string" } } }, "ActionPhase": { "type": "object", "properties": { "action_list_hash": { "type": "string" }, "msgs_created": { "type": "integer" }, "no_funds": { "type": "boolean" }, "result_arg": { "type": "integer" }, "result_code": { "type": "integer" }, "skipped_actions": { "type": "integer" }, "spec_actions": { "type": "integer" }, "status_change": { "type": "string" }, "success": { "type": "boolean" }, "tot_actions": { "type": "integer" }, "tot_msg_size": { "$ref": "#/definitions/MsgSize" }, "total_action_fees": { "type": "string", "example": "0" }, "total_fwd_fees": { "type": "string", "example": "0" }, "valid": { "type": "boolean" } } }, "ActionsResponse": { "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "#/definitions/Action" } }, "address_book": { "$ref": "#/definitions/AddressBook" }, "metadata": { "$ref": "#/definitions/Metadata" } } }, "ActiveNominatorInfo": { "type": "object", "properties": { "address": { "type": "string" }, "balance": { "type": "string" }, "pending_balance": { "type": "string" } } }, "ActonContract": { "type": "object", "properties": { "abi": { "type": "object" }, "catalog_id": { "type": "string" }, "code_hashes": { "type": "array", "items": { "type": "string" } }, "display_name": { "type": "string" }, "get_methods": { "type": "array", "items": { "$ref": "#/definitions/ActonGetMethod" } }, "known_addresses": { "type": "array", "items": { "type": "string" } }, "links": { "type": "array", "items": { "$ref": "#/definitions/ContractLink" } } } }, "ActonContractsResponse": { "type": "object", "properties": { "contracts": { "type": "array", "items": { "$ref": "#/definitions/ActonContract" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer" } } }, "ActonDecodeRequest": { "type": "object", "properties": { "body": { "type": "string" }, "catalog_id": { "type": "string" }, "code_hash": { "type": "string" }, "direction": { "type": "string" } } }, "ActonDecodeResponse": { "type": "object", "properties": { "catalog_id": { "type": "string" }, "decoded": {}, "direction": { "type": "string" }, "type": { "$ref": "#/definitions/acton.TypeInfo" } } }, "ActonGetMethod": { "type": "object", "properties": { "description": { "type": "string" }, "method_id": { "type": "integer" }, "name": { "type": "string" }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/ActonParameter" } }, "return": { "type": "string" }, "unsupported": { "type": "string" } } }, "ActonParameter": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } } }, "ActonRunRequest": { "type": "object", "properties": { "address": { "type": "string" }, "args": { "type": "object" }, "method": { "type": "string" }, "seqno": { "type": "integer" } } }, "ActonRunResponse": { "type": "object", "properties": { "catalog_id": { "type": "string" }, "decode_error": { "type": "string" }, "decoded": {}, "exit_code": { "type": "integer" }, "gas_used": { "type": "string" }, "identification": { "type": "string" }, "method": { "$ref": "#/definitions/ActonGetMethod" }, "raw_stack": { "type": "array", "items": { "type": "object" } }, "snapshot": { "$ref": "#/definitions/ActonSnapshot" }, "stack": { "type": "array", "items": { "$ref": "#/definitions/acton.StackValue" } }, "stack_error": { "type": "string" }, "success": { "type": "boolean" } } }, "ActonSnapshot": { "type": "object", "properties": { "account_state_hash": { "type": "string" }, "account_status": { "type": "string" }, "address": { "type": "string" }, "block_id": { "type": "object" }, "code_hash": { "type": "string" }, "data_hash": { "type": "string" }, "implementation_hash": { "type": "string" }, "last_transaction_hash": { "type": "string" }, "last_transaction_lt": { "type": "string" }, "seqno": { "type": "integer" } } }, "AddressBook": { "type": "object", "additionalProperties": { "$ref": "#/definitions/AddressBookRow" } }, "AddressBookRow": { "type": "object", "properties": { "domain": { "type": "string" }, "interfaces": { "type": "array", "items": { "type": "string" } }, "user_friendly": { "type": "string" } } }, "AddressMetadata": { "type": "object", "properties": { "is_indexed": { "type": "boolean" }, "token_info": { "type": "array", "items": { "$ref": "#/definitions/TokenInfo" } } } }, "Block": { "type": "object", "properties": { "after_merge": { "type": "boolean" }, "after_split": { "type": "boolean" }, "before_split": { "type": "boolean" }, "created_by": { "type": "string" }, "end_lt": { "type": "string", "example": "0" }, "file_hash": { "type": "string" }, "flags": { "type": "integer" }, "gen_catchain_seqno": { "type": "integer" }, "gen_utime": { "type": "string", "example": "0" }, "global_id": { "type": "integer" }, "key_block": { "type": "boolean" }, "master_ref_seqno": { "type": "integer" }, "masterchain_block_ref": { "$ref": "#/definitions/BlockId" }, "min_ref_mc_seqno": { "type": "integer" }, "prev_blocks": { "type": "array", "items": { "$ref": "#/definitions/BlockId" } }, "prev_key_block_seqno": { "type": "integer" }, "rand_seed": { "type": "string" }, "root_hash": { "type": "string" }, "seqno": { "type": "integer" }, "shard": { "type": "string", "example": "0" }, "start_lt": { "type": "string", "example": "0" }, "tx_count": { "type": "integer" }, "validator_list_hash_short": { "type": "integer" }, "version": { "type": "integer" }, "vert_seqno": { "type": "integer" }, "vert_seqno_incr": { "type": "boolean" }, "want_merge": { "type": "boolean" }, "want_split": { "type": "boolean" }, "workchain": { "type": "integer" } } }, "BlockId": { "type": "object", "properties": { "seqno": { "type": "integer" }, "shard": { "type": "string", "example": "0" }, "workchain": { "type": "integer" } } }, "BlocksResponse": { "type": "object", "properties": { "blocks": { "type": "array", "items": { "$ref": "#/definitions/Block" } } } }, "BouncePhase": { "type": "object", "properties": { "fwd_fees": { "type": "string", "example": "0" }, "msg_fees": { "type": "string", "example": "0" }, "msg_size": { "$ref": "#/definitions/MsgSize" }, "req_fwd_fees": { "type": "string", "example": "0" }, "type": { "type": "string" } } }, "CodeBook": { "type": "object", "additionalProperties": { "$ref": "#/definitions/CodeBookRow" } }, "CodeBookRow": { "type": "object", "properties": { "contracts": { "type": "array", "items": { "$ref": "#/definitions/CodeContract" } }, "interfaces": { "type": "array", "items": { "type": "string" } } } }, "CodeContract": { "type": "object", "properties": { "catalog_id": { "type": "string" }, "display_name": { "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/definitions/ContractLink" } } } }, "ComputePhase": { "type": "object", "properties": { "account_activated": { "type": "boolean" }, "exit_arg": { "type": "integer" }, "exit_code": { "type": "integer" }, "gas_credit": { "type": "string", "example": "0" }, "gas_fees": { "type": "string", "example": "0" }, "gas_limit": { "type": "string", "example": "0" }, "gas_used": { "type": "string", "example": "0" }, "mode": { "type": "integer" }, "msg_state_used": { "type": "boolean" }, "reason": { "type": "string" }, "skipped": { "type": "boolean" }, "success": { "type": "boolean" }, "vm_final_state_hash": { "type": "string" }, "vm_init_state_hash": { "type": "string" }, "vm_steps": { "type": "integer" } } }, "ContractLink": { "type": "object", "properties": { "kind": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" } } }, "CreditPhase": { "type": "object", "properties": { "credit": { "type": "string", "example": "0" }, "credit_extra_currencies": { "type": "object", "additionalProperties": { "type": "string" } }, "due_fees_collected": { "type": "string", "example": "0" } } }, "DNSAuction": { "type": "object", "properties": { "auction_end_time": { "type": "string", "example": "0" }, "domain": { "type": "string" }, "finished": { "type": "boolean" }, "last_fill_up_time": { "type": "string", "example": "0" }, "max_bid_address": { "type": "string" }, "max_bid_amount": { "type": "string" }, "nft_item": { "$ref": "#/definitions/NFTItem" }, "nft_item_address": { "type": "string" } } }, "DNSAuctionsResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "auctions": { "type": "array", "items": { "$ref": "#/definitions/DNSAuction" } }, "metadata": { "$ref": "#/definitions/Metadata" }, "next_cursor": { "type": "string" } } }, "DNSRecord": { "type": "object", "properties": { "dns_next_resolver": { "type": "string" }, "dns_site_adnl": { "type": "string" }, "dns_storage_bag_id": { "type": "string" }, "dns_wallet": { "type": "string" }, "domain": { "type": "string" }, "nft_item_address": { "type": "string" }, "nft_item_owner": { "type": "string" } } }, "DNSRecordsResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "records": { "type": "array", "items": { "$ref": "#/definitions/DNSRecord" } } } }, "DecodeRequest": { "type": "object", "properties": { "bodies": { "type": "array", "items": { "type": "string" } }, "opcodes": { "type": "array", "items": { "type": "string" } } } }, "DecodeResponse": { "type": "object", "properties": { "bodies": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "opcodes": { "type": "array", "items": { "type": "string" } } } }, "GenericAddressBook": { "type": "object", "additionalProperties": { "$ref": "#/definitions/AddressBookRow" } }, "JettonBurn": { "type": "object", "properties": { "amount": { "type": "string" }, "custom_payload": { "type": "string" }, "decoded_custom_payload": { "type": "object" }, "jetton_master": { "type": "string" }, "jetton_wallet": { "type": "string" }, "owner": { "type": "string" }, "query_id": { "type": "string" }, "response_destination": { "type": "string" }, "trace_id": { "type": "string" }, "transaction_aborted": { "type": "boolean" }, "transaction_hash": { "type": "string" }, "transaction_lt": { "type": "string", "example": "0" }, "transaction_now": { "type": "integer" } } }, "JettonBurnsResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "jetton_burns": { "type": "array", "items": { "$ref": "#/definitions/JettonBurn" } }, "metadata": { "$ref": "#/definitions/Metadata" } } }, "JettonMaster": { "type": "object", "properties": { "address": { "type": "string" }, "admin_address": { "type": "string" }, "code_hash": { "type": "string" }, "data_hash": { "type": "string" }, "jetton_content": { "type": "object", "additionalProperties": true }, "jetton_wallet_code_hash": { "type": "string" }, "last_transaction_lt": { "type": "string", "example": "0" }, "mintable": { "type": "boolean" }, "total_supply": { "type": "string" } } }, "JettonMastersResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "jetton_masters": { "type": "array", "items": { "$ref": "#/definitions/JettonMaster" } }, "metadata": { "$ref": "#/definitions/Metadata" } } }, "JettonTransfer": { "type": "object", "properties": { "amount": { "type": "string" }, "custom_payload": { "type": "string" }, "decoded_custom_payload": { "type": "object" }, "decoded_forward_payload": { "type": "object" }, "destination": { "type": "string" }, "forward_payload": { "type": "string" }, "forward_ton_amount": { "type": "string" }, "jetton_master": { "type": "string" }, "query_id": { "type": "string" }, "response_destination": { "type": "string" }, "source": { "type": "string" }, "source_wallet": { "type": "string" }, "trace_id": { "type": "string" }, "transaction_aborted": { "type": "boolean" }, "transaction_hash": { "type": "string" }, "transaction_lt": { "type": "string", "example": "0" }, "transaction_now": { "type": "integer" } } }, "JettonTransfersResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "jetton_transfers": { "type": "array", "items": { "$ref": "#/definitions/JettonTransfer" } }, "metadata": { "$ref": "#/definitions/Metadata" } } }, "JettonWallet": { "type": "object", "properties": { "address": { "type": "string" }, "balance": { "type": "string" }, "code_hash": { "type": "string" }, "data_hash": { "type": "string" }, "jetton": { "type": "string" }, "last_transaction_lt": { "type": "string", "example": "0" }, "mintless_info": { "$ref": "#/definitions/JettonWalletMintlessInfo" }, "owner": { "type": "string" } } }, "JettonWalletMintlessInfo": { "type": "object", "properties": { "amount": { "type": "string" }, "custom_payload_api_uri": { "type": "array", "items": { "type": "string" } }, "expire_at": { "type": "integer" }, "start_from": { "type": "integer" } } }, "JettonWalletsResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "jetton_wallets": { "type": "array", "items": { "$ref": "#/definitions/JettonWallet" } }, "metadata": { "$ref": "#/definitions/Metadata" } } }, "MasterchainInfo": { "type": "object", "properties": { "first": { "$ref": "#/definitions/Block" }, "last": { "$ref": "#/definitions/Block" } } }, "Message": { "type": "object", "properties": { "bounce": { "type": "boolean" }, "bounced": { "type": "boolean" }, "created_at": { "type": "string", "example": "0" }, "created_lt": { "type": "string", "example": "0" }, "decoded_opcode": { "type": "string" }, "destination": { "type": "string" }, "extra_flags": { "type": "string" }, "fwd_fee": { "type": "string", "example": "0" }, "hash": { "type": "string" }, "hash_norm": { "type": "string" }, "ihr_disabled": { "type": "boolean" }, "ihr_fee": { "type": "string", "example": "0" }, "import_fee": { "type": "string", "example": "0" }, "in_msg_tx_hash": { "type": "string" }, "init_state": { "$ref": "#/definitions/MessageContent" }, "message_content": { "$ref": "#/definitions/MessageContent" }, "opcode": { "type": "integer" }, "out_msg_tx_hash": { "type": "string" }, "source": { "type": "string" }, "value": { "type": "string", "example": "0" }, "value_extra_currencies": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MessageContent": { "type": "object", "properties": { "body": { "type": "string" }, "decoded": { "type": "object" }, "hash": { "type": "string" } } }, "MessagesResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "metadata": { "$ref": "#/definitions/Metadata" } } }, "Metadata": { "type": "object", "additionalProperties": { "$ref": "#/definitions/AddressMetadata" } }, "MsgSize": { "type": "object", "properties": { "bits": { "type": "string", "example": "0" }, "cells": { "type": "string", "example": "0" } } }, "Multisig": { "type": "object", "properties": { "address": { "type": "string" }, "code_hash": { "type": "string" }, "data_hash": { "type": "string" }, "last_transaction_lt": { "type": "string", "example": "0" }, "next_order_seqno": { "type": "string" }, "orders": { "type": "array", "items": { "$ref": "#/definitions/MultisigOrder" } }, "proposers": { "type": "array", "items": { "type": "string" } }, "signers": { "type": "array", "items": { "type": "string" } }, "threshold": { "type": "integer" } } }, "MultisigOrder": { "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "#/definitions/models.OrderAction" } }, "address": { "type": "string" }, "approvals_mask": { "type": "string" }, "approvals_num": { "type": "integer" }, "code_hash": { "type": "string" }, "data_hash": { "type": "string" }, "expiration_date": { "type": "integer" }, "last_transaction_lt": { "type": "string", "example": "0" }, "multisig_address": { "type": "string" }, "order_boc": { "type": "string" }, "order_seqno": { "type": "string" }, "sent_for_execution": { "type": "boolean" }, "signers": { "type": "array", "items": { "type": "string" } }, "threshold": { "type": "integer" } } }, "MultisigOrderResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "orders": { "type": "array", "items": { "$ref": "#/definitions/MultisigOrder" } } } }, "MultisigResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "multisigs": { "type": "array", "items": { "$ref": "#/definitions/Multisig" } } } }, "NFTCollection": { "type": "object", "properties": { "address": { "type": "string" }, "code_hash": { "type": "string" }, "collection_content": { "type": "object", "additionalProperties": true }, "data_hash": { "type": "string" }, "last_transaction_lt": { "type": "string", "example": "0" }, "next_item_index": { "type": "string" }, "owner_address": { "type": "string" } } }, "NFTCollectionsResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "metadata": { "$ref": "#/definitions/Metadata" }, "nft_collections": { "type": "array", "items": { "$ref": "#/definitions/NFTCollection" } } } }, "NFTItem": { "type": "object", "properties": { "address": { "type": "string" }, "auction_contract_address": { "type": "string" }, "code_hash": { "type": "string" }, "collection": { "$ref": "#/definitions/NFTCollection" }, "collection_address": { "type": "string" }, "content": { "type": "object", "additionalProperties": true }, "data_hash": { "type": "string" }, "index": { "type": "string" }, "init": { "type": "boolean" }, "last_transaction_lt": { "type": "string", "example": "0" }, "on_sale": { "type": "boolean" }, "owner_address": { "type": "string" }, "real_owner": { "type": "string" }, "sale_contract_address": { "type": "string" } } }, "NFTItemsResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "metadata": { "$ref": "#/definitions/Metadata" }, "nft_items": { "type": "array", "items": { "$ref": "#/definitions/NFTItem" } } } }, "NFTSale": { "type": "object", "properties": { "address": { "type": "string" }, "code_hash": { "type": "string" }, "created_at": { "type": "integer" }, "data_hash": { "type": "string" }, "details": {}, "last_transaction_lt": { "type": "string", "example": "0" }, "marketplace_address": { "type": "string" }, "nft_address": { "type": "string" }, "nft_item": { "$ref": "#/definitions/NFTItem" }, "nft_owner_address": { "type": "string" }, "type": { "type": "string" } } }, "NFTSalesResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "metadata": { "$ref": "#/definitions/Metadata" }, "nft_sales": { "type": "array", "items": { "$ref": "#/definitions/NFTSale" } } } }, "NFTTransfer": { "type": "object", "properties": { "custom_payload": { "type": "string" }, "decoded_custom_payload": { "type": "object" }, "decoded_forward_payload": { "type": "object" }, "forward_amount": { "type": "string" }, "forward_payload": { "type": "string" }, "new_owner": { "type": "string" }, "nft_address": { "type": "string" }, "nft_collection": { "type": "string" }, "old_owner": { "type": "string" }, "query_id": { "type": "string" }, "response_destination": { "type": "string" }, "trace_id": { "type": "string" }, "transaction_aborted": { "type": "boolean" }, "transaction_hash": { "type": "string" }, "transaction_lt": { "type": "string", "example": "0" }, "transaction_now": { "type": "integer" } } }, "NFTTransfersResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "metadata": { "$ref": "#/definitions/Metadata" }, "nft_transfers": { "type": "array", "items": { "$ref": "#/definitions/NFTTransfer" } } } }, "NominatorPoolEvent": { "type": "object", "properties": { "amount": { "type": "string" }, "balance_after": { "type": "string" }, "balance_before": { "type": "string" }, "balance_delta": { "type": "string" }, "nominator_address": { "type": "string" }, "pending_balance_after": { "type": "string" }, "pending_balance_before": { "type": "string" }, "pending_balance_delta": { "type": "string" }, "pool_address": { "type": "string" }, "tx_hash": { "type": "string" }, "tx_lt": { "type": "string", "example": "0" }, "type": { "description": "\"reward\", \"deposit\", \"withdrawal\", \"pending_deposit_activation\", \"withdrawal_request\"", "type": "string", "enum": [ "reward", "deposit", "withdrawal", "pending_deposit_activation", "withdrawal_request" ] }, "utime": { "type": "integer" }, "withdraw_request_after": { "type": "boolean" }, "withdraw_request_before": { "type": "boolean" } } }, "NominatorPoolEventsResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "end_utime": { "type": "integer" }, "events": { "type": "array", "items": { "$ref": "#/definitions/NominatorPoolEvent" } }, "start_utime": { "type": "integer" } } }, "NominatorPoolInfo": { "type": "object", "properties": { "active_nominators": { "type": "array", "items": { "$ref": "#/definitions/ActiveNominatorInfo" } }, "address_book": { "$ref": "#/definitions/AddressBook" }, "max_nominators_count": { "type": "integer" }, "min_nominator_stake": { "type": "string" }, "min_validator_stake": { "type": "string" }, "nominators_count": { "type": "integer" }, "stake_amount_sent": { "type": "string" }, "state": { "type": "integer" }, "validator_address": { "type": "string" }, "validator_amount": { "type": "string" }, "validator_reward_share": { "type": "integer" } } }, "NominatorPoolPosition": { "type": "object", "properties": { "balance": { "type": "string" }, "pending_balance": { "type": "string" }, "pool_address": { "type": "string" } } }, "NominatorPoolValidatorEvent": { "type": "object", "properties": { "amount": { "type": "string" }, "balance_after": { "type": "string" }, "balance_before": { "type": "string" }, "balance_delta": { "type": "string" }, "cycle_start": { "type": "integer" }, "pool_address": { "type": "string" }, "query_id": { "type": "string" }, "tx_hash": { "type": "string" }, "tx_lt": { "type": "string", "example": "0" }, "type": { "description": "\"reward\", \"penalty\", \"deposit\", \"withdrawal\"", "type": "string", "enum": [ "reward", "penalty", "deposit", "withdrawal" ] }, "utime": { "type": "integer" }, "validator_address": { "type": "string" }, "validator_reward_share": { "type": "integer" } } }, "NominatorPoolValidatorEventsResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "end_utime": { "type": "integer" }, "events": { "type": "array", "items": { "$ref": "#/definitions/NominatorPoolValidatorEvent" } }, "start_utime": { "type": "integer" } } }, "NominatorPoolValidatorReward": { "type": "object", "properties": { "balance_before": { "type": "string" }, "cycle_start": { "type": "integer" }, "query_id": { "type": "string" }, "reward": { "type": "string" }, "tx_hash": { "type": "string" }, "tx_lt": { "type": "string", "example": "0" }, "utime": { "type": "integer" } } }, "NominatorPoolValidatorRewardsResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "end_utime": { "type": "integer" }, "rewards": { "type": "array", "items": { "$ref": "#/definitions/NominatorPoolValidatorReward" } }, "start_utime": { "type": "integer" }, "total_on_page": { "type": "string" } } }, "NominatorPoolsResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "nominator_pools": { "type": "array", "items": { "$ref": "#/definitions/NominatorPoolPosition" } } } }, "NominatorReward": { "type": "object", "properties": { "reward": { "type": "string" }, "stake_before": { "type": "string" }, "tx_hash": { "type": "string" }, "tx_lt": { "type": "string", "example": "0" }, "utime": { "type": "integer" } } }, "NominatorRewardsResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "end_utime": { "type": "integer" }, "rewards": { "type": "array", "items": { "$ref": "#/definitions/NominatorReward" } }, "start_utime": { "type": "integer" }, "total_on_page": { "type": "string" } } }, "RequestError": { "type": "object", "properties": { "code": { "type": "integer" }, "error": { "type": "string" } } }, "SplitInfo": { "type": "object", "properties": { "acc_split_depth": { "type": "integer" }, "cur_shard_pfx_len": { "type": "integer" }, "sibling_addr": { "type": "string" }, "this_addr": { "type": "string" } } }, "StoragePhase": { "type": "object", "properties": { "status_change": { "type": "string" }, "storage_fees_collected": { "type": "string", "example": "0" }, "storage_fees_due": { "type": "string", "example": "0" } } }, "TokenInfo": { "type": "object", "properties": { "description": { "type": "string" }, "extra": { "type": "object", "additionalProperties": true }, "image": { "type": "string" }, "is_nsfw": { "type": "boolean" }, "is_scam": { "type": "boolean" }, "name": { "type": "string" }, "nft_index": { "type": "string" }, "symbol": { "type": "string" }, "type": { "type": "string" }, "valid": { "type": "boolean" } } }, "Trace": { "type": "object", "properties": { "actions": { "type": "array", "items": { "$ref": "#/definitions/Action" } }, "end_lt": { "type": "string", "example": "0" }, "end_utime": { "type": "integer" }, "external_hash": { "type": "string" }, "is_incomplete": { "type": "boolean" }, "mc_seqno_end": { "type": "string", "example": "0" }, "mc_seqno_start": { "description": "TODO: change it to integer", "type": "string", "example": "0" }, "start_lt": { "type": "string", "example": "0" }, "start_utime": { "type": "integer" }, "trace": { "$ref": "#/definitions/TraceNode" }, "trace_id": { "type": "string" }, "trace_info": { "$ref": "#/definitions/TraceMeta" }, "transactions": { "type": "object", "additionalProperties": { "$ref": "#/definitions/Transaction" } }, "transactions_order": { "type": "array", "items": { "type": "string" } }, "warning": { "type": "string" } } }, "TraceMeta": { "type": "object", "properties": { "classification_state": { "type": "string" }, "messages": { "type": "integer" }, "pending_messages": { "type": "integer" }, "trace_state": { "type": "string" }, "transactions": { "type": "integer" } } }, "TraceNode": { "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/definitions/TraceNode" } }, "in_msg": { "$ref": "#/definitions/Message" }, "in_msg_hash": { "type": "string" }, "transaction": { "$ref": "#/definitions/Transaction" }, "tx_hash": { "type": "string" } } }, "TracesResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "code_book": { "$ref": "#/definitions/CodeBook" }, "metadata": { "$ref": "#/definitions/Metadata" }, "traces": { "type": "array", "items": { "$ref": "#/definitions/Trace" } } } }, "Transaction": { "type": "object", "properties": { "account": { "type": "string" }, "account_state_after": { "$ref": "#/definitions/AccountState" }, "account_state_before": { "$ref": "#/definitions/AccountState" }, "block_ref": { "$ref": "#/definitions/BlockId" }, "description": { "$ref": "#/definitions/TransactionDescr" }, "emulated": { "type": "boolean" }, "end_status": { "type": "string" }, "finality": { "$ref": "#/definitions/models.FinalityState" }, "hash": { "type": "string" }, "in_msg": { "$ref": "#/definitions/Message" }, "lt": { "type": "string", "example": "0" }, "mc_block_seqno": { "type": "integer" }, "now": { "type": "integer" }, "orig_status": { "type": "string" }, "out_msgs": { "type": "array", "items": { "$ref": "#/definitions/Message" } }, "prev_trans_hash": { "type": "string" }, "prev_trans_lt": { "type": "string", "example": "0" }, "total_fees": { "type": "string", "example": "0" }, "total_fees_extra_currencies": { "type": "object", "additionalProperties": { "type": "string" } }, "trace_external_hash": { "type": "string" }, "trace_id": { "type": "string" } } }, "TransactionDescr": { "type": "object", "properties": { "aborted": { "type": "boolean" }, "action": { "$ref": "#/definitions/ActionPhase" }, "bounce": { "$ref": "#/definitions/BouncePhase" }, "compute_ph": { "$ref": "#/definitions/ComputePhase" }, "credit_first": { "type": "boolean" }, "credit_ph": { "$ref": "#/definitions/CreditPhase" }, "destroyed": { "type": "boolean" }, "installed": { "type": "boolean" }, "is_tock": { "type": "boolean" }, "split_info": { "$ref": "#/definitions/SplitInfo" }, "storage_ph": { "$ref": "#/definitions/StoragePhase" }, "type": { "type": "string" } } }, "TransactionsResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "code_book": { "$ref": "#/definitions/CodeBook" }, "transactions": { "type": "array", "items": { "$ref": "#/definitions/Transaction" } } } }, "V2AddressInformation": { "type": "object", "properties": { "balance": { "type": "string" }, "code": { "type": "string" }, "data": { "type": "string" }, "frozen_hash": { "type": "string" }, "last_transaction_hash": { "type": "string" }, "last_transaction_lt": { "type": "string" }, "status": { "type": "string" }, "suspended": { "type": "boolean" } } }, "V2EstimateFeeRequest": { "type": "object", "properties": { "address": { "type": "string" }, "body": { "type": "string" }, "ignore_chksig": { "type": "boolean" }, "init_code": { "type": "string" }, "init_data": { "type": "string" } } }, "V2EstimateFeeResult": { "type": "object", "properties": { "destination_fees": { "type": "array", "items": { "$ref": "#/definitions/V2EstimatedFee" } }, "source_fees": { "$ref": "#/definitions/V2EstimatedFee" } } }, "V2EstimatedFee": { "type": "object", "properties": { "fwd_fee": { "type": "integer" }, "gas_fee": { "type": "integer" }, "in_fwd_fee": { "type": "integer" }, "storage_fee": { "type": "integer" } } }, "V2RunGetMethodRequest": { "type": "object", "properties": { "address": { "type": "string" }, "method": { "type": "string" }, "stack": { "type": "array", "items": { "$ref": "#/definitions/V2StackEntity" } } } }, "V2SendMessageRequest": { "type": "object", "properties": { "boc": { "type": "string" } } }, "V2SendMessageResult": { "type": "object", "properties": { "message_hash": { "type": "string" }, "message_hash_norm": { "type": "string" } } }, "V2StackEntity": { "type": "object", "properties": { "type": { "type": "string" }, "value": {} } }, "V2WalletInformation": { "type": "object", "properties": { "balance": { "type": "string" }, "last_transaction_hash": { "type": "string" }, "last_transaction_lt": { "type": "string" }, "seqno": { "type": "integer" }, "status": { "type": "string" }, "suspended": { "type": "boolean" }, "wallet_id": { "type": "integer" }, "wallet_type": { "type": "string" } } }, "ValidatorComplaint": { "type": "object", "properties": { "adnl_addr": { "type": "string" }, "approved_percent": { "type": "number" }, "complaint_hash": { "type": "string", "example": "PJI18TRG8OZhVPZNN7epvMb25yZivlGQvVj9LC8omOg=" }, "created_at": { "type": "integer" }, "cycle_start": { "type": "integer" }, "description_boc": { "type": "string" }, "election_id": { "type": "integer" }, "is_passed": { "type": "boolean" }, "paid": { "type": "string" }, "reward_address": { "type": "string" }, "severity": { "type": "integer" }, "stake_holder_address": { "type": "string" }, "suggested_fine": { "type": "string" }, "suggested_fine_part": { "type": "integer" }, "validator_pubkey": { "type": "string" }, "voted_validators": { "type": "array", "items": { "$ref": "#/definitions/ValidatorComplaintVote" } }, "vset_id": { "type": "string", "example": "REenLSr+rc8TCU/oc7Hcwburz3bMdA+DJzGA1PAHSes=" }, "weight_remaining": { "type": "string", "example": "0" } } }, "ValidatorComplaintVote": { "type": "object", "properties": { "adnl_addr": { "type": "string" }, "validator_index": { "type": "integer" }, "validator_pubkey": { "type": "string" }, "weight": { "type": "string" } } }, "ValidatorComplaintsResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "complaints": { "type": "array", "items": { "$ref": "#/definitions/ValidatorComplaint" } } } }, "ValidatorCycle": { "type": "object", "properties": { "cycle_end": { "type": "integer" }, "cycle_start": { "type": "integer" }, "election_id": { "type": "integer" }, "elections_end_before": { "type": "integer" }, "elections_start_before": { "type": "integer" }, "main": { "type": "integer" }, "max_main_validators": { "type": "integer" }, "max_stake": { "type": "string" }, "max_stake_factor": { "type": "integer" }, "max_stake_limit": { "type": "string" }, "max_validators": { "type": "integer" }, "min_stake": { "type": "string" }, "min_stake_limit": { "type": "string" }, "min_total_stake": { "type": "string" }, "min_validators": { "type": "integer" }, "stake_held_for": { "type": "integer" }, "total": { "type": "integer" }, "total_stake": { "type": "string" }, "total_weight": { "type": "string" }, "validators": { "type": "array", "items": { "$ref": "#/definitions/ValidatorCycleValidator" } }, "validators_elected_for": { "type": "integer" } } }, "ValidatorCycleValidator": { "type": "object", "properties": { "adnl_addr": { "type": "string" }, "complaints": { "type": "array", "items": { "$ref": "#/definitions/ValidatorComplaint" } }, "max_factor": { "description": "MaxFactor is the participant's raw declared max stake factor (65536 = 1.0), not the effective one.\nThe elector caps it at the cycle's max_stake_factor when computing Stake, so the effective factor a\nconsumer should use to relate Stake and MaxFactor is min(MaxFactor, ValidatorCycle.MaxStakeFactor).", "type": "integer" }, "stake": { "type": "string" }, "stake_holder_address": { "type": "string" }, "validator_index": { "type": "integer" }, "validator_pubkey": { "type": "string" }, "weight": { "type": "string" } } }, "ValidatorCyclesResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "cycles": { "type": "array", "items": { "$ref": "#/definitions/ValidatorCycle" } } } }, "ValidatorElection": { "type": "object", "properties": { "elect_close": { "type": "integer" }, "election_id": { "type": "integer" }, "failed": { "type": "boolean" }, "finished": { "type": "boolean" }, "min_stake": { "type": "string" }, "participants": { "type": "array", "items": { "$ref": "#/definitions/ValidatorElectionParticipant" } }, "total_participants": { "type": "integer" }, "total_stake": { "type": "string" } } }, "ValidatorElectionParticipant": { "type": "object", "properties": { "adnl_addr": { "type": "string" }, "max_factor": { "type": "integer" }, "stake": { "type": "string" }, "stake_holder_address": { "type": "string" }, "validator_index": { "type": "integer" }, "validator_pubkey": { "type": "string" } } }, "ValidatorElectionsResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "elections": { "type": "array", "items": { "$ref": "#/definitions/ValidatorElection" } } } }, "ValidatorEvent": { "type": "object", "properties": { "adnl_addr": { "type": "string" }, "amount": { "type": "string" }, "election_id": { "type": "integer" }, "query_id": { "type": "string" }, "reason": { "type": "integer" }, "stake_holder_address": { "type": "string" }, "tx_hash": { "type": "string" }, "tx_lt": { "type": "string", "example": "0" }, "type": { "description": "\"stake_accepted\", \"stake_rejected\", \"stake_recovered\"", "type": "string", "enum": [ "stake_accepted", "stake_rejected", "stake_recovered" ] }, "utime": { "type": "integer" }, "validator_pubkey": { "type": "string" } } }, "ValidatorEventsResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "end_utime": { "type": "integer" }, "events": { "type": "array", "items": { "$ref": "#/definitions/ValidatorEvent" } }, "start_utime": { "type": "integer" } } }, "VestingContractsResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "vesting_contracts": { "type": "array", "items": { "$ref": "#/definitions/models.VestingInfo" } } } }, "WalletState": { "type": "object", "properties": { "address": { "type": "string" }, "balance": { "type": "string" }, "code_hash": { "type": "string" }, "extra_currencies": { "type": "object", "additionalProperties": { "type": "string" } }, "is_signature_allowed": { "type": "boolean" }, "is_wallet": { "type": "boolean" }, "last_transaction_hash": { "type": "string" }, "last_transaction_lt": { "type": "string", "example": "0" }, "seqno": { "type": "integer" }, "status": { "type": "string" }, "suspended": { "type": "boolean" }, "wallet_id": { "type": "integer" }, "wallet_type": { "type": "string" } } }, "WalletStatesResponse": { "type": "object", "properties": { "address_book": { "$ref": "#/definitions/AddressBook" }, "metadata": { "$ref": "#/definitions/Metadata" }, "wallets": { "type": "array", "items": { "$ref": "#/definitions/WalletState" } } } }, "acton.StackValue": { "type": "object", "properties": { "type": { "type": "string" }, "value": {} } }, "acton.TypeInfo": { "type": "object", "properties": { "name": { "type": "string" }, "ty_idx": { "type": "integer" } } }, "models.FinalityState": { "type": "integer", "format": "int32", "enum": [ 0, 1, 2 ], "x-enum-varnames": [ "FinalityStatePending", "FinalityStateConfirmed", "FinalityStateFinalized" ] }, "models.IndexError": { "type": "object", "properties": { "candidates": { "description": "Candidates names the alternatives a caller can retry with when a request\nwas ambiguous. Empty for every other error.", "type": "array", "items": { "type": "string" } }, "error": { "type": "string" } } }, "models.OrderAction": { "type": "object", "properties": { "body_raw": { "type": "array", "items": { "type": "integer" } }, "destination": { "type": "string" }, "error": { "type": "string" }, "parsed": { "type": "boolean" }, "parsed_body": {}, "parsed_body_type": { "type": "string" }, "send_mode": { "type": "integer" }, "value": { "type": "string" } } }, "models.VestingInfo": { "type": "object", "properties": { "address": { "type": "string" }, "cliff_duration": { "type": "integer" }, "owner_address": { "type": "string" }, "sender_address": { "type": "string" }, "start_time": { "type": "integer" }, "total_amount": { "type": "string" }, "total_duration": { "type": "integer" }, "unlock_period": { "type": "integer" }, "whitelist": { "type": "array", "items": { "type": "string" } } } } }, "securityDefinitions": { "APIKeyHeader": { "type": "apiKey", "name": "X-Api-Key", "in": "header" }, "APIKeyQuery": { "type": "apiKey", "name": "api_key", "in": "query" } } }