POST
/
network
/
options
Get Network Options
curl --request POST \
  --url https://example.com/network/options \
  --header 'Content-Type: application/json' \
  --data '{
  "network_identifier": {
    "blockchain": "bitcoin",
    "network": "mainnet",
    "sub_network_identifier": {
      "network": "shard 1",
      "metadata": {
        "producer": "0x52bc44d5378309ee2abf1539bf71de1b7d7be3b5"
      }
    }
  },
  "metadata": {}
}'
{
  "version": {
    "rosetta_version": "1.2.5",
    "node_version": "1.0.2",
    "middleware_version": "0.2.7",
    "metadata": {}
  },
  "allow": {
    "operation_statuses": [
      {
        "status": "SUCCESS",
        "successful": true
      }
    ],
    "operation_types": [
      "TRANSFER"
    ],
    "errors": [
      {
        "code": 12,
        "message": "Invalid account format",
        "description": "This error is returned when the requested AccountIdentifier is improperly formatted.",
        "retriable": true,
        "details": {
          "address": "0x1dcc4de8dec75d7aab85b567b6",
          "error": "not base64"
        }
      }
    ],
    "historical_balance_lookup": true,
    "timestamp_start_index": 1,
    "call_methods": [
      "eth_call"
    ],
    "balance_exemptions": [
      {
        "sub_account_address": "staking",
        "currency": {
          "symbol": "BTC",
          "decimals": 8,
          "metadata": {
            "Issuer": "Satoshi"
          }
        },
        "exemption_type": "greater_or_equal"
      }
    ],
    "mempool_coins": true
  }
}

Body

application/json

A NetworkRequest is utilized to retrieve some data specific exclusively to a NetworkIdentifier.

network_identifier
object
required

The network_identifier specifies which network a particular object is associated with.

metadata
object

Response

Expected response to a valid request

NetworkOptionsResponse contains information about the versioning of the node and the allowed operation statuses, operation types, and errors.

version
object
required

The Version object is utilized to inform the client of the versions of different components of the Rosetta implementation.

allow
object
required

Allow specifies supported Operation status, Operation types, and all possible error statuses. This Allow object is used by clients to validate the correctness of a Rosetta Server implementation. It is expected that these clients will error if they receive some response that contains any of the above information that is not specified here.