API

Standard JSON RPC 2.0 is used across the board.

Notes:

all methods are HTTP POST
endpoint URL varies by network
- for MainNet use https://rpc.mainnet.near.org
- for TestNet use https://rpc.testnet.near.org
- for BetaNet use https://rpc.betanet.near.org (may be unstable)

You can see this interface defined in nearcore here

note

The commands mentioned on this page beginning with http are using the tool HTTPie. Please install it in order to copy/paste those commands.

Status

status

Returns current status of the node

method query(path: string, data: string)
params none

http post https://rpc.testnet.near.org jsonrpc=2.0 method=status params:='[]' id=dontcare

{
  "id": "dontcare",
  "jsonrpc": "2.0",
  "result": {
    "chain_id": "testnet",
    "rpc_addr": "0.0.0.0:8080",
    "sync_info": {
      "latest_block_hash": "En24v7abQGFMRAeqmA7742z9QUN1ZGvgPyD3BsVpj5fp",
      "latest_block_height": 289032,
      "latest_block_time": "2020-01-23T15:11:41.594468356Z",
      "latest_state_root": "8tJ13zjE6ZRj3CwBdAgbv7fH3Nr4SPaoYygNbqKCReMa",
      "syncing": false
    },
    "validators": [
      {
        "account_id": "far",
        "is_slashed": false
      }
    ],
    "version": {
      "build": "1a0ea717-modified",
      "version": "0.4.12"
    }
  }
}

Send transaction (async)

broadcast_tx_async(signed_transaction: string)

Sends transaction and returns right away with the hash of the transaction in base58.

method broadcast_tx_async
params
- (1) <base 64 of the SignedTransaction>

http post https://rpc.testnet.near.org jsonrpc=2.0 method=broadcast_tx_async params:='["<base 64 of the SignedTransaction>"]' id=dontcare

{
    "id": "dontcare",
    "jsonrpc": "2.0",
    "result": "2i33XJFr6CVhynRXWVtYs9CxaufkKPQMGEYjUgerUyHw"
}

The value of result is the transaction hash and can be viewed in NEAR Explorer

Send Transaction (wait until done)

broadcast_tx_commit(signed_transaction: string)

Sends transaction and returns only until transaction fully gets executed (including receipts). Has timeout of 10 seconds.

method broadcast_tx_commit
params
- (1) <base 64 of the SignedTransaction>

http post http://rpc.testnet.near.org jsonrpc=2.0 method=broadcast_tx_commit params:='["<base 64 of the SignedTransaction>"]' id=dontcare

note: this was tested using NEAR CLI

near call dev-jdvw47f9j setResponse --args '{"apiResponse": "hello"}' --accountId ajax

{
  "receipts_outcome": [
    {
      "block_hash": "8xr1UHftKtth1HErsJ5SEHBgVpbHqyWHQVWeXnT78RfV",
      "id": "Aei6qE1jXnoXA81WvDk69kc8HfPV8kZTRgte38nHV6j8",
      "outcome": {
        "gas_burnt": 2389161082329,
        "logs": [
          "Writing the string [ hello ] to the blockchain ..."
        ],
        "receipt_ids": [
          "Gus1JVoJgBaccBtzHApDs22k6A5CZ8vEgRWHmEhVfQCs"
        ],
        "status": {
          "SuccessValue": ""
        }
      },
      "proof": []
    },
    {
      "block_hash": "11111111111111111111111111111111",
      "id": "Gus1JVoJgBaccBtzHApDs22k6A5CZ8vEgRWHmEhVfQCs",
      "outcome": {
        "gas_burnt": 0,
        "logs": [],
        "receipt_ids": [],
        "status": "Unknown"
      },
      "proof": []
    }
  ],
  "status": {
    "SuccessValue": ""
  },
  "transaction": {
    "actions": [
      {
        "FunctionCall": {
          "args": "eyJhcGlSZXNwb25zZSI6ImhlbGxvIn0=",
          "deposit": "0",
          "gas": 100000000000000,
          "method_name": "setResponse"
        }
      }
    ],
    "hash": "7RnMJsHMVMUbArUdKcMaSBPPomjLzQxzhsuvwP3FXGyi",
    "nonce": 5,
    "public_key": "ed25519:4dYj4upxVxeaiQtV1EB5NvUjuK2axytiAaChr6xNCSgp",
    "receiver_id": "dev-jdvw47f9j",
    "signature": "ed25519:3UrQcvvjuGSWM2w5sQ5GNZYBVWxRMjFbFp1cPg59Qg1rL4PtWMi5s7HY7cgSdx5PB17aqX1nrjiUiK7xxxtBeu6M",
    "signer_id": "ajax"
  },
  "transaction_outcome": {
    "block_hash": "A7NDYejEMJ5RNTdcVuoYDTezruYSh8QKPrVK4TkcUnqy",
    "id": "7RnMJsHMVMUbArUdKcMaSBPPomjLzQxzhsuvwP3FXGyi",
    "outcome": {
      "gas_burnt": 2291572068402,
      "logs": [],
      "receipt_ids": [
        "Aei6qE1jXnoXA81WvDk69kc8HfPV8kZTRgte38nHV6j8"
      ],
      "status": {
        "SuccessReceiptId": "Aei6qE1jXnoXA81WvDk69kc8HfPV8kZTRgte38nHV6j8"
      }
    },
    "proof": []
  }
}

Query

query({ request_type: string, finality: string, ...})

query({ request_type: string, block_id: BlockId, ...})

Learn more about the common identifiers here.

Using request_type parameter you can query various information:

`view_account`

Returns view of account information.

It requires extra arguments passed along within the query:

account_id (string)

Example

http post https://rpc.testnet.near.org jsonrpc=2.0 id=dontcare method=query \
  params:='{
    "request_type": "view_account",
    "finality": "final",
    "account_id": "near.test"
  }'

{
  "jsonrpc": "2.0",
  "id": "dontcare",
  "result": {
    "amount": "10000000999999952626000000",
    "locked": "0",
    "code_hash": "11111111111111111111111111111111",
    "storage_usage": 387,
    "storage_paid_at": 0,
    "block_height": 1498598,
    "block_hash": "BS7nPrqSqhVYGmgeGGcD86KPQh5s68LQP1BtJvQjJ4dY"
  }
}

`view_state`

Returns full state of the contract (might be expensive if contract has large state).

It requires extra arguments passed along within the query:

account_id (string)
prefix_base64 (base64-encoded string)

Example

http post https://rpc.testnet.near.org jsonrpc=2.0 id=dontcare method=query \
  params:='{
    "request_type": "view_state",
    "finality": "final",
    "account_id": "test",
    "prefix_base64": "U1RBVEU="
  }'

NOTE: U1RBVEU= is base64-encoded value of the string "STATE".

{
    "id": "dontcare",
    "jsonrpc": "2.0",
    "result": {
        "block_hash": "3Ys71yxSu33XNj4PG3A4xJDtK6hpeEbVLD9ivsfyvUL7",
        "block_height": 15578976,
        "proof": [],
        "values": [
            {
                "key": "U1RBVEU=",
                "proof": [],
                "value": "CQAAAAAAAAAAAAAAaQMAAAAAAAAACQAAAAAAAAAAAAAAawMAAAAAAAAACQAAAAAAAAAAAAAAdg=="
            }
        ]
    }
}

`view_access_key`

Returns details about access key for given account with this public key. If there is no such access key, returns nothing.

It requires extra arguments passed along within the query:

account_id (string)
public_key (string)

Example

http post https://rpc.testnet.near.org jsonrpc=2.0 id=dontcare method=query \
  params:='{
    "request_type": "view_access_key",
    "finality": "final",
    "account_id": "near.test",
    "public_key": "ed25519:9UfaMwBArFmccTYtzq43K3Kdoncp4kd8rx7cWk57oasL"
  }'

{
  "jsonrpc": "2.0",
  "id": "dontcare",
  "result": {
    "nonce": 0,
    "permission": {
      "FunctionCall": {
        "allowance": "100000000",
        "receiver_id": "studio-d4zxn4xdu",
        "method_names": []
      }
    },
    "block_height": 1499389,
    "block_hash": "8XE2jKwBdfnSj2B7zoQB2GKWCYKdf4HhZRzeaXXqtdDD"
  }
}

`view_access_key_list`

Returns all access keys for given account.

It requires extra arguments passed along within the query:

account_id (string)

Example

http post https://rpc.testnet.near.org jsonrpc=2.0 id=dontcare method=query \
  params:='{
    "request_type": "view_access_key_list",
    "finality": "final",
    "account_id": "near.test"
  }'

{
  "jsonrpc": "2.0",
  "id": "dontcare",
  "result": {
    "keys": [
      {
        "public_key": "ed25519:4Ynh6YmogjUYc5V9VqtQ1pRnZ4KuJSAJdkuj9hLj4a2p",
        "access_key": {
          "nonce": 1,
          "permission": "FullAccess"
        }
      },
      {
        "public_key": "ed25519:9UfaMwBArFmccTYtzq43K3Kdoncp4kd8rx7cWk57oasL",
        "access_key": {
          "nonce": 0,
          "permission": {
            "FunctionCall": {
              "allowance": "100000000",
              "receiver_id": "studio-d4zxn4xdu",
              "method_names": []
            }
          }
        }
      }
    ],
    "block_height": 1499214,
    "block_hash": "9pco3yy126LpgeM2EoFxuuGMcLTepehjwmtBSWS4q8t8"
  }
}

`call_function`

Calls method_name in contract account_id as view function with data as parameters.

It requires extra arguments passed along within the query:

account_id (string)
method_name (string)
args_base64 (base64-encoded string)

Example

http post https://rpc.testnet.near.org jsonrpc=2.0 id=dontcare method=query \
  params:='{
    "request_type": "call_function",
    "finality": "final",
    "account_id": "dev-1588039999690",
    "method_name": "get_num",
    "args_base64": "e30="
  }'

heads up

args_base64 is a base64-encoded data representing input arguments to the contract. near-sdk-rs and near-sdk-as use JSON object with named arguments by default, so e30= is the base64-encoded string of {} (empty JSON object).

{
  "jsonrpc": "2.0",
  "result": {
    "result": [
      48
    ],
    "logs": [],
    "block_height": 1504272,
    "block_hash": "4MkU8Xy82kD875NwXo7gh5wrRbpLrE5gbJ38JHtpp7m1"
  },
  "id": "dontcare"
}

heads up

[48] is an array of bytes, to be specific it is an ASCII code of 0, near-sdk-rs and near-sdk-as return a JSON-serialized results.

Deprecated version of `query` method

query(path: string, data: string)

Queries information in the state machine / database. Where path can be:

method query
params (various)

`account/<account_id>`

Returns view of account information

http post https://rpc.testnet.near.org jsonrpc=2.0 method=query params:='["account/near.test", ""]' id=dontcare

{
  "id": "dontcare",
  "jsonrpc": "2.0",
  "result": {
    "amount": "10000000999999952626000000",
    "block_height": 287825,
    "code_hash": "11111111111111111111111111111111",
    "locked": "0",
    "storage_paid_at": 0,
    "storage_usage": 387
  }
}

`access_key/<account_id>`

Returns all access keys for given account.

http post https://rpc.testnet.near.org jsonrpc=2.0 method=query params:='["access_key/near.test", ""]' id=dontcare

{
  "id": "dontcare",
  "jsonrpc": "2.0",
  "result": {
    "block_height": 287952,
    "keys": [
      {
        "access_key": {
          "nonce": 1,
          "permission": "FullAccess"
        },
        "public_key": "ed25519:4Ynh6YmogjUYc5V9VqtQ1pRnZ4KuJSAJdkuj9hLj4a2p"
      },
      {
        "access_key": {
          "nonce": 0,
          "permission": {
            "FunctionCall": {
              "allowance": "100000000",
              "method_names": [],
              "receiver_id": "dev-d4zxn4xdu"
            }
          }
        },
        "public_key": "ed25519:9UfaMwBArFmccTYtzq43K3Kdoncp4kd8rx7cWk57oasL"
      },
      {
        "access_key": {
          "nonce": 1,
          "permission": "FullAccess"
        },
        "public_key": "ed25519:HzkMAfXsiw2iJ55moB5n2TXNYZFTv1fafWgySUWgE3VQ"
      }
    ]
  }
}

`access_key/<account_id>/<public_key>`

Returns details about access key for given account with this public key. If there is no such access key, returns nothing.

FullAccess key

http post https://rpc.testnet.near.org jsonrpc=2.0 method=query params:='["access_key/near.test/ed25519:4Ynh6YmogjUYc5V9VqtQ1pRnZ4KuJSAJdkuj9hLj4a2p", ""]' id=dontcare

{
  "id": "dontcare",
  "jsonrpc": "2.0",
  "result": {
    "block_height": 288274,
    "nonce": 1,
    "permission": "FullAccess"
  }
}

FunctionCall access key

http post https://rpc.testnet.near.org jsonrpc=2.0 method=query params:='["access_key/near.test/ed25519:9UfaMwBArFmccTYtzq43K3Kdoncp4kd8rx7cWk57oasL", ""]' id=dontcare

{
  "id": "dontcare",
  "jsonrpc": "2.0",
  "result": {
    "block_height": 288293,
    "nonce": 0,
    "permission": {
      "FunctionCall": {
        "allowance": "100000000",
        "method_names": [],
        "receiver_id": "dev-d4zxn4xdu"
      }
    }
  }
}

`contract/<account_id>`

Returns full state of the contract (might be expensive if contract has large state).

http post https://rpc.testnet.near.org jsonrpc=2.0 method=query params:='["contract/my_token", ""]' id=dontcare

{
  "id": "dontcare",
  "jsonrpc": "2.0",
  "result": {
    "block_height": 2057,
    "values": [
      {
        "key": "U1RBVEU=",
        "value": "AgAAAGFpAQAAAAAAAAACAAAAYWsBAAAAAAAAAAIAAABhdqCGAQAAAAAAAAAAAAAAAAA="
      },
      {
        "key": "YWkMAAAAbXlfdmFsaWRhdG9y",
        "value": "AAAAAAAAAAA="
      },
      {
        "key": "YWsAAAAAAAAAAA==",
        "value": "DAAAAG15X3ZhbGlkYXRvcg=="
      },
      {
        "key": "YXYAAAAAAAAAAA==",
        "value": "oIYBAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
      }
    ]
  }
}

The second input parameter is base58-encoded state key prefix.

It is worth noting that the new API nearprotocol/docs#184 uses base64-encoded values. The output keys and values are encoded with base64 (the output is the same for current and the new APIs).

`call/<account_id>/<method_name>`

Calls <method name> in contract <account_id> as view function with data as parameters.

Note: the second parameter is a JSON string encoded with base58 (NOT base64):

http post https://rpc.testnet.near.org/ jsonrpc=2.0 method=query params:='["call/dev-heptm2q29/whoSaidHi","AQ4"]' id=dontcare

{
  "id": "dontcare",
  "jsonrpc": "2.0",
  "result": {
    "block_height": 1388549,
    "logs": [],
    "result": "ImZyb2wubmVhciI="
  }
}

AQ4 is {} (empty JSON object) in base58 encoding. The output result is an array of bytes (numbers) of JSON.

ImZyb2wubmVhciI= is a JSON string "frol.near" (with quotes) in base64 encoding.

Block

block({ block_id: BlockId })

block({ finality: "final" | "near-final" | "optimistic"})

Learn more about the common identifiers here.

Queries network and returns block for given height, hash, or finality state.

method block
params
- (1) <block height as integer> (see NEAR Explorer for a valid block height)

http post https://rpc.testnet.near.org jsonrpc=2.0 id=dontcare \
    method=block \
    params:='{"finality": "final"}'

{
    "id": "dontcare",
    "jsonrpc": "2.0",
    "result": {
        "author": "pool_dokiacapital.stakingpool",
        "chunks": [
            {
                "balance_burnt": "0",
                "chunk_hash": "AYhfzsJ5b4jPnGamNNMut67kiCLunkRVgiUAMFPYPx52",
                "encoded_length": 8,
                "encoded_merkle_root": "9zYue7drR1rhfzEEoc4WUXzaYRnRNihvRoGt1BgK7Lkk",
                "gas_limit": 1000000000000000,
                "gas_used": 0,
                "height_created": 9510569,
                "height_included": 9510569,
                "outcome_root": "11111111111111111111111111111111",
                "outgoing_receipts_root": "H4Rd6SGeEBTbxkitsCdzfu9xL9HtZ2eHoPCQXUeZ6bW4",
                "prev_block_hash": "DKEw7iU9Cttx6gdSSD3XAsgXsMfY2WEG3JoM8vcSNxfY",
                "prev_state_root": "GPQfjSJbwACAXxpBSTBpHDkSbmhg2rRJyY6cA5K7ccup",
                "rent_paid": "0",
                "shard_id": 0,
                "signature": "ed25519:KM45YvaMGfbzWvX3SD3bLTTLFVGvHsKVrVcQPmraekokkfUcGwA9KgU7bQFZg3LHnat5aZbtTQ3bTHS2bjD3uwd",
                "tx_root": "11111111111111111111111111111111",
                "validator_proposals": [],
                "validator_reward": "0"
            }
        ],
        "header": {
            "approvals": [
                "ed25519:4BSpLdU4Nyc13dCGEWtnUjS93FMdRVfV7JyhjYCwXtZ43EqhtJj5aoG3kAtXKdDgYRAiB6BfkQ2xSJHqeLN5FoWh",
                "ed25519:3PCqquTrRzQSPkzWX1BTUDQBn8uq9NWVCDGenh82RFTtU6yLAwLRVCFk5KJtkaDy7NkpZYHmqR8nBVcpsncbmbUA",
                null,
                null,
                "ed25519:3xnWesivtYb6Fhi1XLRTjEdKbyQHDTdymbqWWaPi1Gw6scdM3DY5VKKu6D3ZzWs8ShkWUKLWWcVYyedvFdbW9SAg",
                null,
                null,
                null,
                "ed25519:4pXSBWjAngVP6YhrJz8Vhe9HQ3PEfSCvu7AeYyjtFAyxFFekygpZxrqh3ND4un6PiTDnXTsfCeuj3pjyy46wB7Qf",
                null
            ],
            "block_merkle_root": "BYSJbZAuv9Dk7yUFpXgrzCrcbzTBZHU9FfSe6zY9vjMs",
            "challenges_result": [],
            "challenges_root": "11111111111111111111111111111111",
            "chunk_headers_root": "gpAH66M4iMAhNvnqSdT7cgDfivHaxiB1fCCfjRLJtKA",
            "chunk_mask": [
                true
            ],
            "chunk_receipts_root": "9ETNjrt6MkwTgSVMMbpukfxRshSD1avBUUa4R4NuqwHv",
            "chunk_tx_root": "7tkzFg8RHBmMw1ncRJZCCZAizgq4rwCftTKYLce8RU8t",
            "chunks_included": 1,
            "epoch_id": "5rAWHWvu6gs7CaKRzW98iRQEw7vEm548cM77BzXpCzpG",
            "gas_price": "5000",
            "hash": "61TVxP8pPRnWub2EcehmC2viaSb5cWYeSDrV9pwxsZmQ",
            "height": 9510569,
            "last_ds_final_block": "DKEw7iU9Cttx6gdSSD3XAsgXsMfY2WEG3JoM8vcSNxfY",
            "last_final_block": "AavU7BS2WdVPZ1CP6SmbHUGjtNc7PGrAadca7hWLJPCc",
            "latest_protocol_version": 22,
            "next_bp_hash": "AjsjrZe3GSXU54X2TNmX5Lwobr3hT2kQuapfvH7PohXc",
            "next_epoch_id": "FnFjGWZ4YJa7ykrSLW2AY5Ah88mB1GnUXS6STFZ1ebYN",
            "outcome_root": "7tkzFg8RHBmMw1ncRJZCCZAizgq4rwCftTKYLce8RU8t",
            "prev_hash": "DKEw7iU9Cttx6gdSSD3XAsgXsMfY2WEG3JoM8vcSNxfY",
            "prev_state_root": "4UD59EPxzcsySoo8mYrY2BcUtYdwLgUvzSLe4cutUU2V",
            "random_value": "FxEt7GA7JQRoiYesktiLTra5j3w3onHbTxdbWcwwgGKd",
            "rent_paid": "0",
            "signature": "ed25519:3YfecVTo4CKqBQPQXzr6aZBv6Ea8cN4Urk9CUhZChoGNBZcU8Y7LWnNBRixNGooyyWHyRGQAn3bQAsf4akTZBm8q",
            "timestamp": 1594630037386307076,
            "total_supply": "1025557301750471574004577919621361",
            "validator_proposals": [],
            "validator_reward": "0"
        }
    }
}

Deprecated version of Block API

heads up

The deprecated method only differs in the input parameters, but the output matches the new method.

block(block_height: u64 | block_hash: string)

Queries network and returns block for given height. If there was re-org, this may differ.

method block
params
- (1) <block height as integer> (see NEAR Explorer for a valid block height)

http post https://rpc.testnet.near.org jsonrpc=2.0 method=block params:='[2003340]' id=dontcare

{
  "jsonrpc": "2.0",
  "id": "dontcare",
  "result": {
    "author": "node3",
    "header": {
      "height": 2003340,
      "epoch_id": "3mHzgVWca7GgBc9kQTUY1neKDqzUhkRbpUrMFs1pbWXL",
      "next_epoch_id": "ghpXGxdeLYR1BHvEDJwXF6LYhBsZjytvMkutFyHCtR5",
      "hash": "pUgKX4nT2P6p9aLLMyYh59HQ89i2svbXMsqjdMbdm8F",
      "prev_hash": "FRvF7tvmSAvv4S4vBqQJW75wNfHctU9kGCzAqTp32j78",
      "prev_state_root": "2xZks5S5zih4bW11A6D5YaQi8sfPy3dEkWWXbKSrPe2y",
      "chunk_receipts_root": "9ETNjrt6MkwTgSVMMbpukfxRshSD1avBUUa4R4NuqwHv",
      "chunk_headers_root": "2yKDs8h6UNVDCgLsfCbRck4GibjFAQTA9Y6HS4Aghegp",
      "chunk_tx_root": "7tkzFg8RHBmMw1ncRJZCCZAizgq4rwCftTKYLce8RU8t",
      "outcome_root": "7tkzFg8RHBmMw1ncRJZCCZAizgq4rwCftTKYLce8RU8t",
      "chunks_included": 1,
      "challenges_root": "11111111111111111111111111111111",
      "timestamp": 1588426142437337600,
      "random_value": "CCg1wPWwmvghmLPY1naVavLyFofuRmwvmVp6t3GS9FgQ",
      "score": 2003339,
      "validator_proposals": [],
      "chunk_mask": [
        true
      ],
      "gas_price": "5000",
      "rent_paid": "0",
      "validator_reward": "0",
      "total_supply": "1013828364958054936724694759912258",
      "challenges_result": [],
      "last_quorum_pre_vote": "FRvF7tvmSAvv4S4vBqQJW75wNfHctU9kGCzAqTp32j78",
      "last_quorum_pre_commit": "3RQoGgRMVXyeFxsNBTpZanGqh3renAYyUvH7HH7xGTZP",
      "last_ds_final_block": "FRvF7tvmSAvv4S4vBqQJW75wNfHctU9kGCzAqTp32j78",
      "next_bp_hash": "6jpyHheNEh6f1Q51ZQyDfSsvfBWPFm28d6UBFFAnaaMv",
      "approvals": [
        [
          "node2",
          "FRvF7tvmSAvv4S4vBqQJW75wNfHctU9kGCzAqTp32j78",
          "3tBxnzb7KECu2VybM9bmSin9JUY1Pb8HYc6FagWBzGZR",
          2003340,
          true,
          "ed25519:2wVmQ3XaRsah78aumVo1rwMewEAghiCgNwFMEJFJT4hWyvf2vC6WVQ57SSS7q6P8wyxrf3neke2d2ypQTcWMMYiX"
        ],
        [
          "node1",
          "FRvF7tvmSAvv4S4vBqQJW75wNfHctU9kGCzAqTp32j78",
          "Gi3yTYjAiXzJAmA9EKBeMUnD32Q912nv93PJesKSuGZT",
          2003340,
          true,
          "ed25519:rx11xEhwPRDEnrRcNaUyQX5omkZSsoZGHp2jrYoLhWZQTumP4e2NnoLCvy8ocdMxvJoAqhm2jBzxmguhhSSg9MJ"
        ],
        [
          "node3",
          "FRvF7tvmSAvv4S4vBqQJW75wNfHctU9kGCzAqTp32j78",
          "8CXfTGtNNAi6U5Tnh29qZ7Am6u9tg4QXoWJ1LuiPPShg",
          2003340,
          true,
          "ed25519:36do9Jb1PHXHqVNZgeZU6KW9uWQwmLwqJt8qFwzRes22URkuKZLgQ7Y5qyWjGCNW7jyMeyeMCSTyApo6HH5DAab2"
        ],
        [
          "node0",
          "FRvF7tvmSAvv4S4vBqQJW75wNfHctU9kGCzAqTp32j78",
          "8CXfTGtNNAi6U5Tnh29qZ7Am6u9tg4QXoWJ1LuiPPShg",
          2003340,
          true,
          "ed25519:4Z6Gup9m4h5Zf6pSXt1UK8X7BjhJcb78RWPJRoaTjutvT77F765yC4aREV81JYe1UuQmm293Y6ctSBCFV8XgBCgb"
        ]
      ],
      "signature": "ed25519:vegMXf9vz3hD3bfSW9JbwoHnGf1WpFzqZGWwEWnTbXNYDTKCrRki8XNMjNd1GCxHKSJv8faZHoY3qTThKsbqMka"
    },
    "chunks": [
      {
        "chunk_hash": "FcsjvpEmDbiaxeGNmZJt4KxnZEd9TBA6htBWBp5y1jg2",
        "prev_block_hash": "FRvF7tvmSAvv4S4vBqQJW75wNfHctU9kGCzAqTp32j78",
        "outcome_root": "11111111111111111111111111111111",
        "prev_state_root": "9Ec16Drf8MQwKMoxkHtNz3Qq5wJpWd3bebuMj5PJyujU",
        "encoded_merkle_root": "DMJ4Ava2GSEqCwUuAFX7mCvAZRWRYPVZ6ABKsubPUE3H",
        "encoded_length": 8,
        "height_created": 2003340,
        "height_included": 2003340,
        "shard_id": 0,
        "gas_used": 0,
        "gas_limit": 1000000000000000,
        "rent_paid": "0",
        "validator_reward": "0",
        "balance_burnt": "0",
        "outgoing_receipts_root": "H4Rd6SGeEBTbxkitsCdzfu9xL9HtZ2eHoPCQXUeZ6bW4",
        "tx_root": "11111111111111111111111111111111",
        "validator_proposals": [],
        "signature": "ed25519:3PtiM9fFpkchpvavqQUHpPJDHXbRaPj42qNPoKosHafg539eRmNPGUaGMfA9LyjBAtcyLjMXpqWrmv9DVfjug2yM"
      }
    ]
  }
}

Chunk

chunk(chunk_hash: string)

Queries for details of a specific chunk appending details of receipts and transactions to the same chunk data provided by block()

method chunk
params
- (1) <base 58 chunk hash> (see status page for a valid latest_block_hash then use this to retrieve any chunk_hash from the returned collection of result.chunks)

http post https://rpc.testnet.near.org jsonrpc=2.0 method=chunk params:='["9tHJjVZ9CikzNax8i6fKE3rDDQHKXBuXp4pR7M879nxS"]' id=dontcare

{
  "id": "dontcare",
  "jsonrpc": "2.0",
  "result": {
    "header": {
      "balance_burnt": "0",
      "chunk_hash": "31d9LCJrwXZ4hWuPrPeKbHaFMwSnJPrmm7Tt2MWaAcQx",
      "encoded_length": 235,
      "encoded_merkle_root": "CoCmpsJ4AteJDA2kTNfhLNVBx7PLhf4yc1bbCszzjZw",
      "gas_limit": 1000000000000000,
      "gas_used": 0,
      "height_created": 789406,
      "height_included": 0,
      "outcome_root": "11111111111111111111111111111111",
      "outgoing_receipts_root": "6m2bJP9TiEtxqHSzLygPCQqiGdgYQQYaSYTFeP2gEUQj",
      "prev_block_hash": "4sm53hoomwPSyp2sjoUXtjryiH2BcKpXWXyLKcj2uYsQ",
      "prev_state_root": "2p1FppanS4h3Hyff8hbC6pYLCTtBZwuhSM4mdSY2K4LM",
      "rent_paid": "0",
      "shard_id": 0,
      "signature": "ed25519:96CQeZ9VDmfmLMWLoGQ5NxZ6UaGAwjy8sDiXXxQybAMhUnmf6q6D3TdMW1Gndn8VAtNyV4v9gCuAcDpMJEi2tbQ",
      "tx_root": "7xQr3bwtiF7DmuZAWmxnn7Suqexwj7U2BJ8gknmB4vm8",
      "validator_proposals": [],
      "validator_reward": "0"
    },
    "receipts": [],
    "transactions": [
      {
        "actions": [
          {
            "FunctionCall": {
              "args": "eyJjb2xvciI6MTA3fQ==",
              "deposit": "0",
              "gas": 2000000000000,
              "method_name": "changeColor"
            }
          }
        ],
        "hash": "AtvAvhYNV8vLCBCzFwJSY7q7dEeFHD7sv4zrvyLAbRkv",
        "nonce": 2,
        "public_key": "ed25519:7x6Dxh6VmWDaDhKzuxrU6XZve9SsnMUbC628DtKG22WS",
        "receiver_id": "mikedotdmg",
        "signature": "ed25519:2pxR9DNN8cqk1FuN8s6iB38Rz3hLDrhDsDuFkGgDA73YVtPPg4zGLJteqap1kXTC77pBoWumawLxAnWBKrSmSVGi",
        "signer_id": "mikedotdmg"
      }
    ]
  }
}

Transaction Status

tx(transaction_hash: string, sender_id: string)

Queries status of a transaction by hash and returns FinalTransactionResult.

method tx
params
- (1) <base 58 of transaction hash> (see NEAR Explorer for a valid transaction hash)
- (2) <sender account id> used to determine which shard to look for transaction

http post https://rpc.testnet.near.org jsonrpc=2.0 method=tx params:='["CqiBnYCRgkGV2odJPXJTBkoZHXjDNQFJKw7oRYWU1j6g", ""]' id=dontcare

{
  "id": "dontcare",
  "jsonrpc": "2.0",
  "result": {
    "receipts_outcome": [
      {
        "block_hash": "52yXcXjL6gR2HV5c5bXdv3FE7uGgcXdCaipq9MQo9kUx",
        "id": "Cj9eqPrvh9oCAUi6hRxiQjJzsEAa7bQnja3q5U6bX5yC",
        "outcome": {
          "gas_burnt": 924119500000,
          "logs": [],
          "receipt_ids": [],
          "status": {
            "SuccessValue": ""
          }
        },
        "proof": [
          {
            "direction": "Left",
            "hash": "8SxoArHHF3ko3RvigCxCHGLtbWg9XiQawQEGraMAZ3yy"
          }
        ]
      }
    ],
    "status": {
      "SuccessValue": ""
    },
    "transaction": {
      "actions": [
        {
          "AddKey": {
            "access_key": {
              "nonce": 0,
              "permission": "FullAccess"
            },
            "public_key": "ed25519:9y5RuRL7YaGKxsbZynHQjVktVVMCk4fMNywkTYiqdnPz"
          }
        }
      ],
      "hash": "CqiBnYCRgkGV2odJPXJTBkoZHXjDNQFJKw7oRYWU1j6g",
      "nonce": 1,
      "public_key": "ed25519:8xNjM142ibwb79JvY7u6grXFEtEgeaohez1HmoAwC7xT",
      "receiver_id": "david_sanford80wirethingsnet",
      "signature": "ed25519:4e3aAi93Fdk4GEnzFTddhnFwHzN8rrSXbkS9sJfbpnn5MJSLFVp8TF2TjQcWXQmtY5Mb9EPJ1KdV91h1UJ2zg5Ld",
      "signer_id": "david_sanford80wirethingsnet"
    },
    "transaction_outcome": {
      "block_hash": "52yXcXjL6gR2HV5c5bXdv3FE7uGgcXdCaipq9MQo9kUx",
      "id": "CqiBnYCRgkGV2odJPXJTBkoZHXjDNQFJKw7oRYWU1j6g",
      "outcome": {
        "gas_burnt": 924119500000,
        "logs": [],
        "receipt_ids": [
          "Cj9eqPrvh9oCAUi6hRxiQjJzsEAa7bQnja3q5U6bX5yC"
        ],
        "status": {
          "SuccessReceiptId": "Cj9eqPrvh9oCAUi6hRxiQjJzsEAa7bQnja3q5U6bX5yC"
        }
      },
      "proof": [
        {
          "direction": "Right",
          "hash": "81vrGGwyr15GvPkhMeV3NcHZLRy6T2z86JQyeyZPe87r"
        }
      ]
    }
  }
}

Please note that, in the case of function call transactions, the query will not wait for all the receipts generated by this transaction to finish before returning. Rather, it will only wait for the its return value to finish (could be a promise) before returning. More specifically, consider the following function

pub fn transfer(receiver_id: String) {
    Promise::new(receiver_id).transfer(10);
}

Let's say a transaction only contain a function call action that calls this method. It will only wait for the function call receipt, not necessarily the receipt that contains the transfer, to finish before returning. On the other hand, if the function is slightly modified

pub fn transfer_promise(receiver_id: String) -> Promise {
    Promise::new(receiver_id).transfer(10)
}

to have the promise as a return value, then the tx status query will wait for this promise to finish before returning.

Despite such design, tx endpoint can be used to check whether all receipts have finished. Instead of looking at status, we can go through all the receipts returned and see if any of their status is Unknown. If none of the status is unknown, we can be certain that all receipts generated have finished.

In addition, tx endpoint does not provide finality guarantees. To make sure that the entire execution is final, it suffices to check that every block_hash in every outcome is final.

Validators

validators(block_hash: string)

Queries for active validators on the network and returns details about them and the current state of validation on the blockchain

method validators
params
- (1) <base 58 block hash> or block number for a specific block or pass null for latest

http post https://rpc.testnet.near.org jsonrpc=2.0 method=validators params:='[null]' id=dontcare

{
  "id": "dontcare",
  "jsonrpc": "2.0",
  "result": {
    "current_fishermen": [],
    "current_proposals": [],
    "current_validators": [
      {
        "account_id": "far",
        "is_slashed": false,
        "num_expected_blocks": 330,
        "num_produced_blocks": 330,
        "public_key": "ed25519:7rNEmDbkn8grQREdTt3PWhR1phNtsqJdgfV26XdR35QL",
        "shards": [
          0,
          1,
          2,
          3,
          4,
          5,
          6,
          7
        ],
        "stake": "200004186292589888646450791793915395"
      }
    ],
    "next_fishermen": [],
    "next_validators": [
      {
        "account_id": "far",
        "public_key": "ed25519:7rNEmDbkn8grQREdTt3PWhR1phNtsqJdgfV26XdR35QL",
        "shards": [
          0,
          1,
          2,
          3,
          4,
          5,
          6,
          7
        ],
        "stake": "200004229452627983713359803935223094"
      }
    ]
  }
}

Gas Price

gas_price(null | block_height: u64 | block_hash: string)

Queries for gas price using null (for latest) as well as a specific block_height or block_hash.

method gas_price
params
- (1) (see status page for a valid latest_block_hash or use null for latest)

http post https://rpc.testnet.near.org jsonrpc=2.0 method=gas_price params:='["8ehA3NYL5uSF8zefbnqnz66twYJ45rfst6SrqBNv7oka"]' id=dontcare

{
  "id": "dontcare",
  "jsonrpc": "2.0",
  "result": {
    "gas_price": "5000"
  }
}

State Changes / Experimental Methods

Please see our Experimental Methods section for more information.

Rust

AssemblyScript

JavaScript

JSON RPC

Status

Send transaction (async)

Send Transaction (wait until done)

Query

`view_account`

Example

`view_state`

Example

`view_access_key`

Example

`view_access_key_list`

Example

`call_function`

Example

Deprecated version of `query` method

`account/<account_id>`

`access_key/<account_id>`

`access_key/<account_id>/<public_key>`

`contract/<account_id>`

`call/<account_id>/<method_name>`

Block

Deprecated version of Block API

Chunk

Transaction Status

Validators

Gas Price

State Changes / Experimental Methods

Status

Send transaction (async)

Send Transaction (wait until done)

Query

view_account

Example

view_state

Example

view_access_key

Example

view_access_key_list

Example

call_function

Example

Deprecated version of query method

account/<account_id>

access_key/<account_id>

access_key/<account_id>/<public_key>

contract/<account_id>

call/<account_id>/<method_name>

Block

Deprecated version of Block API

Chunk

Transaction Status

Validators

Gas Price

State Changes / Experimental Methods

`view_account`

`view_state`

`view_access_key`

`view_access_key_list`

`call_function`

Deprecated version of `query` method

`account/<account_id>`

`access_key/<account_id>`

`access_key/<account_id>/<public_key>`

`contract/<account_id>`

`call/<account_id>/<method_name>`