Accounts

Accounts Api

Deprecated

Get account (v1)

get

Response

  • auth_key — The authentication key used for validating transactions.

  • sequence_number — The current expected sequence number of the account.

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Responses
200
Account information retrieved successfully
application/json
Responseone of
nullOptional
or
get
GET /rpc/v1/accounts/{address} HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

Account information retrieved successfully

No content

Deprecated

Get coin transactions (v1)

get

List of finalized coin withdraw/deposit transactions relevant to the move account. Return max 100 transactions per request. It includes both transactions sent from and received by the account.

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Query parameters
countintegerOptional

Maximum number of items to return. Default is 20.

startinteger · u-int64Optional

The cursor that the search should start from. The cursor for a given transaction can be derived by adding its index (where indexes start from zero) in the block in which it became finalized to the timestamp of the block.

During a paginated query, the cursor returned in the previous page should be used as the starting cursor of the next page.

If provided, return :count of transactions starting from this cursor in ascending order. If not provided, return :count of most recent transactions in descending order.

Responses
200
List of *finalized* transactions sent from and received by the move account.
application/json
get
GET /rpc/v1/accounts/{address}/coin_transactions HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

List of finalized transactions sent from and received by the move account.

{
  "record": [
    {
      "authenticator": {},
      "block_header": null,
      "hash": "text",
      "header": {
        "chain_id": 1,
        "expiration_timestamp": {
          "timestamp": 1
        },
        "sender": "text",
        "sequence_number": 1,
        "gas_unit_price": 1,
        "max_gas_amount": 1
      },
      "payload": {},
      "output": {
        "Dkg": "Success"
      },
      "status": "Success"
    }
  ],
  "cursor": 1
}
Deprecated

Get account modules (v1)

get

Get account modules by address

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Query parameters
countintegerOptional

Maximum number of items to return. Default is 20.

startstringOptional

Cursor specifying where to start for pagination. Use the cursor returned by the API when making the next request.

Responses
200
Account module list
application/json
Responseone of
or
get
GET /rpc/v1/accounts/{address}/modules HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

Account module list

{
  "Resources": {
    "resource": [
      []
    ],
    "cursor": [
      1
    ]
  }
}
Deprecated

Get account module (v1)

get

Retrieves an individual module from a given account.

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
module_namestringRequired

Name of module to retrieve e.g. coin

Responses
200
View account module by Move module name
application/json
Responseone of
nullOptional
or
get
GET /rpc/v1/accounts/{address}/modules/{module_name} HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

View account module by Move module name

No content

Deprecated

Get account resources (v1)

get

Get account resources by address

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Query parameters
countintegerOptional

Maximum number of items to return. Default is 20.

startstringOptional

Cursor specifying where to start for pagination. Use the cursor returned by the API when making the next request.

Responses
200
Account resource list
application/json
Responseone of
or
get
GET /rpc/v1/accounts/{address}/resources HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

Account resource list

{
  "Resources": {
    "resource": [
      []
    ],
    "cursor": [
      1
    ]
  }
}
Deprecated

Get account resource (v1)

get

View account resource by Move type

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
resource_typestringRequired

Name of struct to retrieve e.g. 0x1::account::Account

Example: 0x1::coin::CoinStore<0x1::supra_coin::SupraCoin>Pattern: ^0x[0-9a-zA-Z:_<>]+$
Responses
200
View account resource by Move Struct type
application/json
Responseone of
nullOptional
or
get
GET /rpc/v1/accounts/{address}/resources/{resource_type} HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

View account resource by Move Struct type

No content

Deprecated

Get account transactions (v1)

get

List of finalized transactions sent by the move account. Return max 100 transactions per request.

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Query parameters
countintegerOptional

Maximum number of items to return. Default is 20.

startinteger · u-int64Optional

Starting sequence number. If provided, return :count of transactions starting from this sequence number in ascending order. If not provided, return :count of most recent transactions in descending order.

Responses
200
List of transactions from the move account.
application/json
get
GET /rpc/v1/accounts/{address}/transactions HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

List of transactions from the move account.

{
  "record": [
    {
      "authenticator": {},
      "block_header": null,
      "hash": "text",
      "header": {
        "chain_id": 1,
        "expiration_timestamp": {
          "timestamp": 1
        },
        "sender": "text",
        "sequence_number": 1,
        "gas_unit_price": 1,
        "max_gas_amount": 1
      },
      "payload": {},
      "output": {
        "Dkg": "Success"
      },
      "status": "Success"
    }
  ]
}

Get account (v2)

get

Response

  • auth_key — The authentication key used for validating transactions.

  • sequence_number — The current expected sequence number of the account.

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Responses
200
Account information retrieved successfully
application/json
get
GET /rpc/v2/accounts/{address} HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

Account information retrieved successfully

{
  "sequence_number": 1,
  "authentication_key": "text"
}

Get coin transactions (v2)

get

List of finalized coin withdraw/deposit transactions relevant to the move account. Return max 100 transactions per request. It includes both transactions sent from and received by the account.

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Query parameters
countintegerOptional

Maximum number of items to return. Default is 20.

startinteger · u-int64Optional

The cursor that the search should start from. The cursor for a given transaction can be derived by adding its index (where indexes start from zero) in the block in which it became finalized to the timestamp of the block.

During a paginated query, the cursor returned in the previous page should be used as the starting cursor of the next page.

If provided, return :count of transactions starting from this cursor in ascending order. If not provided, return :count of most recent transactions in descending order.

Responses
200
List of *finalized* transactions sent from and received by the move account.
application/json
get
GET /rpc/v2/accounts/{address}/coin_transactions HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

List of finalized transactions sent from and received by the move account.

{
  "record": [
    {
      "authenticator": {},
      "block_header": null,
      "hash": "text",
      "header": {
        "chain_id": 1,
        "expiration_timestamp": {
          "timestamp": 1
        },
        "sender": "text",
        "sequence_number": 1,
        "gas_unit_price": 1,
        "max_gas_amount": 1
      },
      "payload": {},
      "output": {
        "Dkg": "Success"
      },
      "status": "Success"
    }
  ],
  "cursor": 1
}

Get account modules (v2)

get

Retrieves all account modules' bytecode for a given account.

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Query parameters
countintegerOptional

Maximum number of items to return. Default is 20.

startstringOptional

Cursor specifying where to start for pagination. Use the cursor returned by the API when making the next request.

Responses
200
account module list
application/json
get
GET /rpc/v2/accounts/{address}/modules HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

account module list

{
  "modules": [
    {
      "bytecode": "text",
      "abi": {
        "address": "text",
        "name": {},
        "friends": {},
        "exposed_functions": {},
        "structs": {}
      }
    }
  ],
  "cursor": null
}

Get account module (v2)

get

Retrieves an individual module from a given account.

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
module_namestringRequired

Name of module to retrieve e.g. coin

Responses
200
View account module by Move module name
application/json
get
GET /rpc/v2/accounts/{address}/modules/{module_name} HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

View account module by Move module name

{
  "bytecode": "text",
  "abi": {
    "address": "text",
    "name": {},
    "friends": {},
    "exposed_functions": {},
    "structs": {}
  }
}

Get account resources (v2)

get

Get account resources by address

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Query parameters
countintegerOptional

Maximum number of items to return. Default is 20.

startstringOptional

Cursor specifying where to start for pagination. Use the cursor returned by the API when making the next request.

Responses
200
Account resource list
application/json
get
GET /rpc/v2/accounts/{address}/resources HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

Account resource list

{
  "resources": [
    {
      "type": "text",
      "data": {}
    }
  ],
  "cursor": "text"
}

Get account resource (v2)

get

View account resource by Move type

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
resource_typestringRequired

Name of struct to retrieve e.g. 0x1::account::Account

Example: 0x1::coin::CoinStore<0x1::supra_coin::SupraCoin>Pattern: ^0x[0-9a-zA-Z:_<>]+$
Responses
200
View account resource by Move Struct type
application/json
get
GET /rpc/v2/accounts/{address}/resources/{resource_type} HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

View account resource by Move Struct type

{
  "type": "text",
  "data": {}
}

Get account transactions (v2)

get

List of finalized transactions sent by the move account. Return max 100 transactions per request.

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Query parameters
countintegerOptional

Maximum number of items to return. Default is 20.

startinteger · u-int64Optional

Starting sequence number. If provided, return :count of transactions starting from this sequence number in ascending order. If not provided, return :count of most recent transactions in descending order.

Responses
200
List of transactions from the move account.
application/json
get
GET /rpc/v2/accounts/{address}/transactions HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

List of transactions from the move account.

{
  "record": [
    {
      "authenticator": {},
      "block_header": null,
      "hash": "text",
      "header": {
        "chain_id": 1,
        "expiration_timestamp": {
          "timestamp": 1
        },
        "sender": "text",
        "sequence_number": 1,
        "gas_unit_price": 1,
        "max_gas_amount": 1
      },
      "payload": {},
      "output": {
        "Dkg": "Success"
      },
      "status": "Success"
    }
  ]
}

Get account (v3)

get

Response

  • auth_key — The authentication key used for validating transactions.

  • sequence_number — The current expected sequence number of the account.

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Responses
200
Account information retrieved successfully
get
GET /rpc/v3/accounts/{address} HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

Account information retrieved successfully

{
  "sequence_number": 1,
  "authentication_key": "text"
}

Get account auto-transaction (v3)

get

List of finalized automated transactions based on the automation tasks registered by the move account. Return max 100 transactions per request.

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Query parameters
countintegerOptional

Maximum number of items to return. Default is 20.

block_heightinteger · u-int64Optional

Starting block height (inclusive). Optional.

The block height at which to start lookup for transactions. If provided, returns :count of transactions starting from it in the specified order. For order see :ascending flag.

Note: If a :cursor is specified then this field will be ignored.

cursorstringOptional

The cursor (exclusive) to start the query from. Optional.

If provided, returns :count of transactions starting from this cursor in the specified order. For order see :ascending flag.

If not specified, the lookup will be done based on the :block_height parameter value. Note: If both :cursor and :block_height are specified then :cursor has precedence.

ascendingbooleanOptional

Flag indicating order of lookup.

Defaults to false; i.e. transactions are returned in descending order of their execution. If true, transactions are returned in ascending order of their execution.

Responses
200
List of automated transactions of the move account.
get
GET /rpc/v3/accounts/{address}/automated_transactions HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

List of automated transactions of the move account.

[
  {
    "authenticator": {},
    "block_header": null,
    "hash": "text",
    "header": {
      "chain_id": 1,
      "expiration_timestamp": {
        "timestamp": 1
      },
      "sender": "text",
      "sequence_number": 1,
      "gas_unit_price": 1,
      "max_gas_amount": 1
    },
    "payload": {},
    "output": {
      "Dkg": "Success"
    },
    "status": "Success",
    "txn_type": "user"
  }
]

Get coin transactions (v3)

get

List of finalized coin withdraw/deposit transactions relevant to the move account. Return max 100 transactions per request.

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Query parameters
countintegerOptional

Maximum number of items to return. Default is 20.

startinteger · u-int64Optional

The cursor (exclusive) that the search should start from.

If provided, returns :count of transactions starting from this cursor in the specified order.

For order see :ascending flag.

ascendingbooleanOptional

Flag indicating order of lookup.

Defaults to false i.e. transactions are returned in descending order of their execution. If true, transactions are returned in ascending order of their execution.

typestring · enumOptional

Type of the transaction to be queried.

Possible values:
Responses
200
List of *finalized* transactions sent from and received by the move account.
get
GET /rpc/v3/accounts/{address}/coin_transactions HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

List of finalized transactions sent from and received by the move account.

[
  {
    "authenticator": {},
    "block_header": null,
    "hash": "text",
    "header": {
      "chain_id": 1,
      "expiration_timestamp": {
        "timestamp": 1
      },
      "sender": "text",
      "sequence_number": 1,
      "gas_unit_price": 1,
      "max_gas_amount": 1
    },
    "payload": {},
    "output": {
      "Dkg": "Success"
    },
    "status": "Success",
    "txn_type": "user"
  }
]

Get account modules (v3)

get

Retrieves all account modules' bytecode for a given account.

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Query parameters
countintegerOptional

Maximum number of items to return. Default is 20.

startstringOptional

Cursor specifying where to start for pagination. Use the cursor returned by the API when making the next request.

Responses
200
Account module list
get
GET /rpc/v3/accounts/{address}/modules HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

Account module list

[
  {
    "bytecode": "text",
    "abi": {
      "address": "text",
      "name": {},
      "friends": {},
      "exposed_functions": {},
      "structs": {}
    }
  }
]

Get account module (v3)

get

Retrieves an individual module from a given account.

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
module_namestringRequired

Name of module to retrieve e.g. coin

Responses
200
View account module by Move module name
get
GET /rpc/v3/accounts/{address}/modules/{module_name} HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

View account module by Move module name

{
  "bytecode": "text",
  "abi": {
    "address": "text",
    "name": {},
    "friends": {},
    "exposed_functions": {},
    "structs": {}
  }
}

Get account resources (v3)

get

Retrieves all account resources for a given account.

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Query parameters
countintegerOptional

Maximum number of items to return. Default is 20.

startstringOptional

Cursor specifying where to start for pagination. Use the cursor returned by the API when making the next request.

Responses
200
Account resource list
get
GET /rpc/v3/accounts/{address}/resources HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

Account resource list

[
  {
    "type": "text",
    "data": {}
  }
]

Get account resource (v3)

get

View account resource by Move type

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
resource_typestringRequired

Name of struct to retrieve e.g. 0x1::account::Account

Example: 0x1::coin::CoinStore<0x1::supra_coin::SupraCoin>Pattern: ^0x[0-9a-zA-Z:_<>]+$
Responses
200
View account resource by Move Struct type
get
GET /rpc/v3/accounts/{address}/resources/{resource_type} HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

View account resource by Move Struct type

{
  "type": "text",
  "data": {}
}

Get account transactions (v3)

get

List of finalized transactions sent by the move account. Return max 100 transactions per request.

Path parameters
addressstringRequired

Address of account with or without a 0x prefix

Example: 0x88fbd33f54e1126269769780feb24480428179f552e2313fbe571b72e62a1ca1
Query parameters
countintegerOptional

Maximum number of items to return. Default is 20.

startinteger · u-int64Optional

Starting sequence number.

If provided, return :count of transactions starting from this sequence number (inclusive) in the specified order.

For order see :ascending flag.

ascendingbooleanOptional

Flag indicating order of lookup.

Defaults to false; i.e. the transactions are returned in descending order by sequence number. If true, transactions are returned in ascending order by sequence number.

Responses
200
List of transactions from the move account.
get
GET /rpc/v3/accounts/{address}/transactions HTTP/1.1
Host: rpc-mainnet.supra.com
Accept: */*
200

List of transactions from the move account.

[
  {
    "authenticator": {},
    "block_header": null,
    "hash": "text",
    "header": {
      "chain_id": 1,
      "expiration_timestamp": {
        "timestamp": 1
      },
      "sender": "text",
      "sequence_number": 1,
      "gas_unit_price": 1,
      "max_gas_amount": 1
    },
    "payload": {},
    "output": {
      "Dkg": "Success"
    },
    "status": "Success",
    "txn_type": "user"
  }
]