Skip to main content

/v1/accounts/:address:/resource/:resource_type:

info

Retrieves an individual resource from a given account and at a specific ledger version.

Parameters

  • address REQUIRED: (string) - Address of account with or without a 0x prefix
  • resource_type REQUIRED: (string) - Name of struct to retrieve 0x1::account::Account
  • ledger_version OPTIONAL: (string)- Ledger version to get the state of the account

Returns

  • array of:
    • type (string)
      • String representation of a MoveStructTag (on-chain Move struct type). This exists so you can specify MoveStructTags as path / query parameters, e.g. for get_events_by_event_handle.
      • It is a combination of:
        1. move_module_address, module_name, and struct_name, all joined by ::
        2. struct generic type parameters joined by ,
    • data (object)
      • This is a JSON representation of some data within an account resource. More specifically, it is a map of strings to arbitrary JSON values / objects, where the keys are top-level fields within the given resource.

      • To clarify, you might query for 0x1::account::Account and see the example data.

        Move bool type value is serialized into boolean.

        Move u8 type value is serialized into integer.

        Move u64 and u128 type value is serialized into string.

        Move address type value (32 byte Aptos account address) is serialized into a HexEncodedBytes string. For example:

        • 0x1
        • 0x1668f6be25668c1a17cd8caf6b8d2f25

        Move vector type value is serialized into array, except vector<u8> which is serialized into a HexEncodedBytes string with 0x prefix. For example:

        • vector<u64>{255, 255} => ["255", "255"]
        • vector<u8>{255, 255} => 0xffff

Move struct type value is serialized into object that looks like this (except some Move stdlib types, see the following section):

{ 
field1_name: field1_value,
field2_name: field2_value, ......
}

Example

Request

curl --request GET \
--url https://aptos-mainnet.blastapi.io/<project-id>/v1/accounts/0x1d8727df513fa2a8785d0834e40b34223daff1affc079574082baadb74b66ee4/resource/0x1::account::Account \
--header 'Content-Type: application/json'

Result

{
"type": "0x1::account::Account",
"data": {
"authentication_key": "0x1d8727df513fa2a8785d0834e40b34223daff1affc079574082baadb74b66ee4",
"coin_register_events": {
"counter": "1",
"guid": {
"id": {
"addr": "0x1d8727df513fa2a8785d0834e40b34223daff1affc079574082baadb74b66ee4",
"creation_num": "0"
}
}
},
"guid_creation_num": "4",
"key_rotation_events": {
"counter": "0",
"guid": {
"id": {
"addr": "0x1d8727df513fa2a8785d0834e40b34223daff1affc079574082baadb74b66ee4",
"creation_num": "1"
}
}
},
"rotation_capability_offer": {
"for": {
"vec": []
}
},
"sequence_number": "83912",
"signer_capability_offer": {
"for": {
"vec": []
}
}
}
}