openapi: 3.0.0 info: title: Aptos Node Accounts API description: The Aptos Node API is a RESTful API for client applications to interact with the Aptos blockchain. version: 1.2.0 contact: name: Aptos Labs url: https://github.com/aptos-labs/aptos-core license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html servers: - url: /v1 tags: - name: Accounts description: Access to accounts, resources, and modules paths: /accounts/{address}: get: tags: - Accounts summary: Get account description: 'Return the authentication key and the sequence number for an account address. Optionally, a ledger version can be specified. If the ledger version is not specified in the request, the latest ledger version is used.' parameters: - name: address schema: $ref: '#/components/schemas/Address' in: path description: Address of account with or without a `0x` prefix required: true deprecated: false explode: true - name: ledger_version schema: $ref: '#/components/schemas/U64' in: query description: 'Ledger version to get state of account If not provided, it will be the latest version' required: false deprecated: false explode: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AccountData' application/x-bcs: schema: type: array items: type: integer format: uint8 headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain required: true deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-CURSOR: description: 'Cursor to be used for endpoints that support cursor-based pagination. Pass this to the `start` field of the endpoint on the next call to get the next page of results.' deprecated: false schema: type: string X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '400': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '403': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '404': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '410': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '500': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '503': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string operationId: get_account /accounts/{address}/resources: get: tags: - Accounts summary: Get account resources description: 'Retrieves all account resources for a given account and a specific ledger version. If the ledger version is not specified in the request, the latest ledger version is used. The Aptos nodes prune account state history, via a configurable time window. If the requested ledger version has been pruned, the server responds with a 410.' parameters: - name: address schema: $ref: '#/components/schemas/Address' in: path description: Address of account with or without a `0x` prefix required: true deprecated: false explode: true - name: ledger_version schema: $ref: '#/components/schemas/U64' in: query description: 'Ledger version to get state of account If not provided, it will be the latest version' required: false deprecated: false explode: true - name: start schema: $ref: '#/components/schemas/StateKeyWrapper' in: query description: 'Cursor specifying where to start for pagination This cursor cannot be derived manually client-side. Instead, you must call this endpoint once without this query parameter specified, and then use the cursor returned in the X-Aptos-Cursor header in the response.' required: false deprecated: false explode: true - name: limit schema: type: integer format: uint16 in: query description: 'Max number of account resources to retrieve If not provided, defaults to default page size.' required: false deprecated: false explode: true responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/MoveResource' application/x-bcs: schema: type: array items: type: integer format: uint8 headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain required: true deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-CURSOR: description: 'Cursor to be used for endpoints that support cursor-based pagination. Pass this to the `start` field of the endpoint on the next call to get the next page of results.' deprecated: false schema: type: string X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '400': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '403': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '404': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '410': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '500': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '503': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string operationId: get_account_resources /accounts/{address}/balance/{asset_type}: get: tags: - Accounts summary: Get account balance description: 'Retrieves account balance for coins / fungible asset (only for primary fungible asset store) for a given account, asset type and a specific ledger version. If the ledger version is not specified in the request, the latest ledger version is used. The Aptos nodes prune account state history, via a configurable time window. If the requested ledger version has been pruned, the server responds with a 410.' parameters: - name: address schema: $ref: '#/components/schemas/Address' in: path description: Address of account with or without a `0x` prefix required: true deprecated: false explode: true - name: asset_type schema: $ref: '#/components/schemas/AssetType' in: path required: true deprecated: false explode: true - name: ledger_version schema: $ref: '#/components/schemas/U64' in: query description: 'Ledger version to get state of account If not provided, it will be the latest version' required: false deprecated: false explode: true responses: '200': description: '' content: application/json: schema: type: integer format: uint64 application/x-bcs: schema: type: array items: type: integer format: uint8 headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain required: true deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-CURSOR: description: 'Cursor to be used for endpoints that support cursor-based pagination. Pass this to the `start` field of the endpoint on the next call to get the next page of results.' deprecated: false schema: type: string X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '400': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '403': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '404': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '410': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '500': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '503': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string operationId: get_account_balance /accounts/{address}/modules: get: tags: - Accounts summary: Get account modules description: 'Retrieves all account modules'' bytecode for a given account at a specific ledger version. If the ledger version is not specified in the request, the latest ledger version is used. The Aptos nodes prune account state history, via a configurable time window. If the requested ledger version has been pruned, the server responds with a 410.' parameters: - name: address schema: $ref: '#/components/schemas/Address' in: path description: Address of account with or without a `0x` prefix required: true deprecated: false explode: true - name: ledger_version schema: $ref: '#/components/schemas/U64' in: query description: 'Ledger version to get state of account If not provided, it will be the latest version' required: false deprecated: false explode: true - name: start schema: $ref: '#/components/schemas/StateKeyWrapper' in: query description: 'Cursor specifying where to start for pagination This cursor cannot be derived manually client-side. Instead, you must call this endpoint once without this query parameter specified, and then use the cursor returned in the X-Aptos-Cursor header in the response.' required: false deprecated: false explode: true - name: limit schema: type: integer format: uint16 in: query description: 'Max number of account modules to retrieve If not provided, defaults to default page size.' required: false deprecated: false explode: true responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/MoveModuleBytecode' application/x-bcs: schema: type: array items: type: integer format: uint8 headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain required: true deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-CURSOR: description: 'Cursor to be used for endpoints that support cursor-based pagination. Pass this to the `start` field of the endpoint on the next call to get the next page of results.' deprecated: false schema: type: string X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '400': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '403': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '404': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '410': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '500': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '503': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string operationId: get_account_modules /accounts/{address}/resource/{resource_type}: get: tags: - Accounts summary: Get account resource description: 'Retrieves an individual resource from a given account and at a specific ledger version. If the ledger version is not specified in the request, the latest ledger version is used. The Aptos nodes prune account state history, via a configurable time window. If the requested ledger version has been pruned, the server responds with a 410.' parameters: - name: address schema: $ref: '#/components/schemas/Address' in: path description: Address of account with or without a `0x` prefix required: true deprecated: false explode: true - name: resource_type schema: $ref: '#/components/schemas/MoveStructTag' in: path description: Name of struct to retrieve e.g. `0x1::account::Account` required: true deprecated: false explode: true - name: ledger_version schema: $ref: '#/components/schemas/U64' in: query description: 'Ledger version to get state of account If not provided, it will be the latest version' required: false deprecated: false explode: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/MoveResource' application/x-bcs: schema: type: array items: type: integer format: uint8 headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain required: true deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-CURSOR: description: 'Cursor to be used for endpoints that support cursor-based pagination. Pass this to the `start` field of the endpoint on the next call to get the next page of results.' deprecated: false schema: type: string X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '400': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '403': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '404': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '410': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '500': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '503': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string operationId: get_account_resource /accounts/{address}/module/{module_name}: get: tags: - Accounts summary: Get account module description: 'Retrieves an individual module from a given account and at a specific ledger version. If the ledger version is not specified in the request, the latest ledger version is used. The Aptos nodes prune account state history, via a configurable time window. If the requested ledger version has been pruned, the server responds with a 410.' parameters: - name: address schema: $ref: '#/components/schemas/Address' in: path description: Address of account with or without a `0x` prefix required: true deprecated: false explode: true - name: module_name schema: $ref: '#/components/schemas/IdentifierWrapper' in: path description: Name of module to retrieve e.g. `coin` required: true deprecated: false explode: true - name: ledger_version schema: $ref: '#/components/schemas/U64' in: query description: 'Ledger version to get state of account If not provided, it will be the latest version' required: false deprecated: false explode: true responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/MoveModuleBytecode' application/x-bcs: schema: type: array items: type: integer format: uint8 headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain required: true deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain required: true deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-CURSOR: description: 'Cursor to be used for endpoints that support cursor-based pagination. Pass this to the `start` field of the endpoint on the next call to get the next page of results.' deprecated: false schema: type: string X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '400': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '403': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '404': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '410': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '500': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string '503': description: '' content: application/json: schema: $ref: '#/components/schemas/AptosError' headers: X-APTOS-CHAIN-ID: description: Chain ID of the current chain deprecated: false schema: type: integer format: uint8 X-APTOS-LEDGER-VERSION: description: Current ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-OLDEST-VERSION: description: Oldest non-pruned ledger version of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-LEDGER-TIMESTAMPUSEC: description: Current timestamp of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-EPOCH: description: Current epoch of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-BLOCK-HEIGHT: description: Current block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-OLDEST-BLOCK-HEIGHT: description: Oldest non-pruned block height of the chain deprecated: false schema: type: integer format: uint64 X-APTOS-GAS-USED: description: The cost of the call in terms of gas deprecated: false schema: type: integer format: uint64 X-APTOS-TXN-ENCRYPTION-KEY: description: Per-epoch transaction encryption key (hex-encoded) deprecated: false schema: type: string operationId: get_account_module components: schemas: MoveModuleId: type: string description: 'Move module id is a string representation of Move module. Format: `{address}::{module name}` `address` should be hex-encoded 32 byte account address that is prefixed with `0x`. Module name is case-sensitive. ' example: 0x1::aptos_coin AptosError: type: object description: 'This is the generic struct we use for all API errors, it contains a string message and an Aptos API specific error code.' required: - message - error_code properties: message: type: string description: A message describing the error error_code: $ref: '#/components/schemas/AptosErrorCode' vm_error_code: type: integer format: uint64 description: A code providing VM error details when submitting transactions to the VM MoveAbility: type: string Address: type: string format: hex description: 'A hex encoded 32 byte Aptos account address. This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x. For example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1. ' example: 61959483996478237799081788855878961092127547100767458402256961684167818091681 MoveStructField: type: object description: Move struct field required: - name - type properties: name: $ref: '#/components/schemas/IdentifierWrapper' type: $ref: '#/components/schemas/MoveType' MoveStructValue: type: object description: "This is a JSON representation of some data within an account resource. More specifically,\nit is a map of strings to arbitrary JSON values / objects, where the keys are top level\nfields within the given resource.\n\nTo clarify, you might query for 0x1::account::Account and see the example data.\n\nMove `bool` type value is serialized into `boolean`.\n\nMove `u8`, `u16`, `u32`, `i8`, `i16`, and `i32` type value is serialized into `integer`.\n\nMove `u64`, `u128`, `u256`, `i64`, `i128`, and `i256` type value is serialized into `string`.\n\nMove `address` type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string.\nFor example:\n - `0x1`\n - `0x1668f6be25668c1a17cd8caf6b8d2f25`\n\nMove `vector` type value is serialized into `array`, except `vector` which is serialized into a\nHexEncodedBytes string with `0x` prefix.\nFor example:\n - `vector{255, 255}` => `[\"255\", \"255\"]`\n - `vector{255, 255}` => `0xffff`\n\nMove `struct` type value is serialized into `object` that looks like this (except some Move stdlib types, see the following section):\n ```json\n {\n field1_name: field1_value,\n field2_name: field2_value,\n ......\n }\n ```\n\nFor example:\n `{ \"created\": \"0xa550c18\", \"role_id\": \"0\" }`\n\n**Special serialization for Move stdlib types**:\n - [0x1::string::String](https://github.com/aptos-labs/aptos-core/blob/main/third_party/move/move-stdlib/docs/ascii.md)\n is serialized into `string`. For example, struct value `0x1::string::String{bytes: b\"Hello World!\"}`\n is serialized as `\"Hello World!\"` in JSON.\n" example: authentication_key: '0x0000000000000000000000000000000000000000000000000000000000000001' coin_register_events: counter: '0' guid: id: addr: '0x1' creation_num: '0' self_address: '0x1' sequence_number: '0' MoveFunction: type: object description: Move function required: - name - visibility - is_entry - is_view - generic_type_params - params - return properties: name: $ref: '#/components/schemas/IdentifierWrapper' visibility: $ref: '#/components/schemas/MoveFunctionVisibility' is_entry: type: boolean description: Whether the function can be called as an entry function directly in a transaction is_view: type: boolean description: Whether the function is a view function or not generic_type_params: type: array description: Generic type params associated with the Move function items: $ref: '#/components/schemas/MoveFunctionGenericTypeParam' params: type: array description: Parameters associated with the move function items: $ref: '#/components/schemas/MoveType' return: type: array description: Return type of the function items: $ref: '#/components/schemas/MoveType' AptosErrorCode: type: string description: 'These codes provide more granular error information beyond just the HTTP status code of the response.' enum: - account_not_found - resource_not_found - module_not_found - struct_field_not_found - version_not_found - transaction_not_found - table_item_not_found - block_not_found - state_value_not_found - version_pruned - block_pruned - invalid_input - invalid_transaction_update - sequence_number_too_old - vm_error - rejected_by_filter - health_check_failed - mempool_is_full - rate_limited - internal_error - web_framework_error - bcs_not_supported - api_disabled HexEncodedBytes: type: string format: hex description: 'All bytes (Vec) data is represented as hex-encoded string prefixed with `0x` and fulfilled with two hex digits per byte. Unlike the `Address` type, HexEncodedBytes will not trim any zeros. ' example: 61959483996478237799081788855878961092127547100767458402256961684167818091681 MoveStructTag: type: string description: "String representation of a MoveStructTag (on-chain Move struct type). This exists so you\ncan specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.\n\nIt is a combination of:\n 1. `move_module_address`, `module_name` and `struct_name`, all joined by `::`\n 2. `struct generic type parameters` joined by `, `\n\nExamples:\n * `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>`\n * `0x1::account::Account`\n\nNote:\n 1. Empty chars should be ignored when comparing 2 struct tag ids.\n 2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).\n\nSee [doc](https://aptos.dev/concepts/accounts) for more details.\n" example: 0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin> pattern: ^0x[0-9a-zA-Z:_<>]+$ MoveModuleBytecode: type: object description: Move module bytecode along with it's ABI required: - bytecode properties: bytecode: $ref: '#/components/schemas/HexEncodedBytes' abi: $ref: '#/components/schemas/MoveModule' MoveStructVariant: type: object description: A single variant of a Move enum. required: - name - fields properties: name: $ref: '#/components/schemas/IdentifierWrapper' fields: type: array description: Fields associated with the variant, if any. items: $ref: '#/components/schemas/MoveStructField' MoveFunctionGenericTypeParam: type: object description: Move function generic type param required: - constraints properties: constraints: type: array description: Move abilities tied to the generic type param and associated with the function that uses it items: $ref: '#/components/schemas/MoveAbility' MoveResource: type: object description: A parsed Move resource required: - type - data properties: type: $ref: '#/components/schemas/MoveStructTag' data: $ref: '#/components/schemas/MoveStructValue' MoveModule: type: object description: A Move module required: - address - name - friends - exposed_functions - structs properties: address: $ref: '#/components/schemas/Address' name: $ref: '#/components/schemas/IdentifierWrapper' friends: type: array description: Friends of the module items: $ref: '#/components/schemas/MoveModuleId' exposed_functions: type: array description: Public functions of the module items: $ref: '#/components/schemas/MoveFunction' structs: type: array description: Structs of the module items: $ref: '#/components/schemas/MoveStruct' MoveStruct: type: object description: A move struct required: - name - is_native - is_event - is_enum - abilities - generic_type_params - fields - variants properties: name: $ref: '#/components/schemas/IdentifierWrapper' is_native: type: boolean description: Whether the struct is a native struct of Move is_event: type: boolean description: 'Whether the struct is marked with the #[event] annotation' is_enum: type: boolean description: Whether the struct is an enum (i.e. enum MyEnum vs struct MyStruct). abilities: type: array description: Abilities associated with the struct items: $ref: '#/components/schemas/MoveAbility' generic_type_params: type: array description: Generic types associated with the struct items: $ref: '#/components/schemas/MoveStructGenericTypeParam' fields: type: array description: Fields associated with the struct items: $ref: '#/components/schemas/MoveStructField' variants: type: array description: Variants of the enum. Only populated when `is_enum` is true. items: $ref: '#/components/schemas/MoveStructVariant' AssetType: type: string format: hex description: 'A hex encoded 32 byte Aptos account address or a struct tag. This is represented in a string as a 64 character hex string, sometimes shortened by stripping leading 0s, and adding a 0x or Format: `{address}::{module name}::{struct name}` ' example: 0x1::aptos_coin::AptosCoin AccountData: type: object description: 'Account data A simplified version of the onchain Account resource' required: - sequence_number - authentication_key properties: sequence_number: $ref: '#/components/schemas/U64' authentication_key: $ref: '#/components/schemas/HexEncodedBytes' MoveStructGenericTypeParam: type: object description: Move generic type param required: - constraints properties: constraints: type: array description: Move abilities tied to the generic type param and associated with the type that uses it items: $ref: '#/components/schemas/MoveAbility' U64: type: string format: uint64 description: 'A string containing a 64-bit unsigned integer. We represent u64 values as a string to ensure compatibility with languages such as JavaScript that do not parse u64s in JSON natively. ' example: '32425224034' IdentifierWrapper: type: string MoveFunctionVisibility: type: string description: Move function visibility enum: - private - public - friend MoveType: type: string description: "String representation of an on-chain Move type tag that is exposed in transaction payload.\n Values:\n - bool\n - u8\n - u16\n - u32\n - u64\n - u128\n - u256\n - i8\n - i16\n - i32\n - i64\n - i128\n - i256\n - address\n - signer\n - vector: `vector<{non-reference MoveTypeId}>`\n - struct: `{address}::{module_name}::{struct_name}::<{generic types}>`\n\n Vector type value examples:\n - `vector`\n - `vector>`\n - `vector<0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>>`\n\n Struct type value examples:\n - `0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>\n - `0x1::account::Account`\n\n Note:\n 1. Empty chars should be ignored when comparing 2 struct tag ids.\n 2. When used in an URL path, should be encoded by url-encoding (AKA percent-encoding).\n" pattern: ^(bool|u8|u16|u32|u64|u128|u256|i8|i16|i32|i64|i128|i256|address|signer|vector<.+>|0x[0-9a-zA-Z:_<, >]+)$ StateKeyWrapper: type: string description: 'Representation of a StateKey as a hex string. This is used for cursor based pagination. ' example: 0000000000000000000000000000000000000000000000000000000000000000012f0000000000000000000000000000000000000000000000000000000000000000010d7374616b696e675f70726f7879 externalDocs: url: https://github.com/aptos-labs/aptos-core