--- updatedAt: 2025-09-18T22:07:05.000Z agentTools: projectIndex: https://docs.nodereal.io/llms.txt --- # Get account resource 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. # OpenAPI definition ````json { "openapi": "3.0.0", "info": { "title": "Aptos Node 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": "{server_url}/{api_key}/v1", "variables": { "user_token": { "description": "Aptos node API token", "default": "{api_key}" }, "server_url": { "description": "Aptos node API url", "default": "aptos-mainnet.nodereal.io/v1" } } } ], "tags": [ { "name": "Accounts", "description": "Access to accounts, resources, and modules" } ], "paths": { "/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\nledger version is not specified in the request, the latest ledger version is used.\n\nThe Aptos nodes prune account state history, via a configurable time window.\nIf 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\n\nIf 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" } } } }, "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" } } } }, "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" } } } }, "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" } } } }, "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" } } } }, "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" } } } }, "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" } } } } }, "operationId": "get_account_resource" } } }, "components": { "schemas": { "Address": { "type": "string", "format": "hex", "description": "A hex encoded 32 byte Aptos account address.\n\nThis is represented in a string as a 64 character hex string, sometimes\nshortened by stripping leading 0s, and adding a 0x.\n\nFor example, address 0x0000000000000000000000000000000000000000000000000000000000000001 is represented as 0x1.\n", "example": "0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1 " }, "AptosError": { "type": "object", "description": "This is the generic struct we use for all API errors, it contains a string\nmessage 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" } } }, "AptosErrorCode": { "type": "string", "description": "These codes provide more granular error information beyond just the HTTP\nstatus 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", "version_pruned", "block_pruned", "invalid_input", "invalid_transaction_update", "sequence_number_too_old", "vm_error", "health_check_failed", "mempool_is_full", "internal_error", "web_framework_error", "bcs_not_supported", "api_disabled" ] }, "MoveResource": { "type": "object", "description": "A parsed Move resource", "required": [ "type", "data" ], "properties": { "type": { "$ref": "#/components/schemas/MoveStructTag" }, "data": { "$ref": "#/components/schemas/MoveStructValue" } } }, "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/basics-accounts) for more details.\n", "example": "0x1::coin::CoinStore<0x1::aptos_coin::AptosCoin>", "pattern": "^0x[0-9a-zA-Z:_<>]+$" }, "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` type value is serialized into `integer`.\n\nMove `u64` and `u128` 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/language/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" } }, "U64": { "type": "string", "format": "uint64", "description": "A string containing a 64-bit unsigned integer.\n\nWe represent u64 values as a string to ensure compatibility with languages such\nas JavaScript that do not parse u64s in JSON natively.\n", "example": "32425224034" } } }, "externalDocs": { "url": "https://github.com/aptos-labs/aptos-core" }, "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ````