OMG Network Info API

GET
/alarm.get

Note: Service operator alarms.

Response Body

application/json

application/json

curl -X GET "https://example.com/alarm.get"
{
  "data": [
    {
      "disk_almost_full": "/dev/null",
      "ethereum_connection_error": {},
      "ethereum_stalled_sync": {},
      "system_memory_high_watermark": []
    }
  ]
}
{
  "success": false,
  "data": {
    "object": "error",
    "code": "server:internal_server_error",
    "description": "Something went wrong on the server",
    "messages": {
      "error_key": "error_reason"
    }
  }
}

Provides configuration values

GET
/configuration.get

Note: Configuration values.

Response Body

application/json

application/json

curl -X GET "https://example.com/configuration.get"
{
  "data": [
    {
      "deposit_finality_margin": 10,
      "contract_semver": "1.0.0.1+a1s29s8",
      "exit_processor_sla_margin": 5520,
      "network": "RINKEBY"
    }
  ]
}
{
  "success": false,
  "data": {
    "object": "error",
    "code": "server:internal_server_error",
    "description": "Something went wrong on the server",
    "messages": {
      "error_key": "error_reason"
    }
  }
}

Returns the balance of each currency for the given account address.

POST
/account.get_balance

Request Body

application/json

HEX-encoded address of the account and pagination fields

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/account.get_balance" \  -H "Content-Type: application/json" \  -d '{    "address": "0xb3256026863eb6ae5b06fa396ab09069784ea8ea",    "limit": 100,    "page": 2  }'
{
  "data": [
    {
      "currency": "0xbfdf85743ef16cfb1f8d4dd1dfc74c51dc496434",
      "amount": 20
    },
    {
      "currency": "0x0000000000000000000000000000000000000000",
      "amount": 1000000000
    }
  ]
}
{
  "success": false,
  "data": {
    "object": "error",
    "code": "server:internal_server_error",
    "description": "Something went wrong on the server",
    "messages": {
      "error_key": "error_reason"
    }
  }
}

Gets all utxos belonging to the given address.

POST
/account.get_utxos

Request Body

application/json

HEX-encoded address of the account and pagination fields

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/account.get_utxos" \  -H "Content-Type: application/json" \  -d '{    "address": "0xb3256026863eb6ae5b06fa396ab09069784ea8ea",    "limit": 100,    "page": 2  }'
{
  "data": [
    {
      "amount": 10,
      "blknum": 123000,
      "creating_txhash": "0x2c499b95ccb6bf7b923049b32b03a613d30882a448102136e544b302119eb722",
      "currency": "0x0000000000000000000000000000000000000000",
      "inserted_at": "2020-02-10T12:07:32Z",
      "oindex": 0,
      "otype": 1,
      "owner": "0xb3256026863eb6ae5b06fa396ab09069784ea8ea",
      "spending_txhash": null,
      "txindex": 111,
      "updated_at": "2020-02-15T04:07:57Z",
      "utxo_pos": 123000001110000
    }
  ],
  "data_paging": {
    "page": 1,
    "limit": 200
  }
}
{
  "success": false,
  "data": {
    "object": "error",
    "code": "server:internal_server_error",
    "description": "Something went wrong on the server",
    "messages": {
      "error_key": "error_reason"
    }
  }
}

Gets a list of transactions for given account address.

POST
/account.get_transactions

Request Body

application/json

Account address, block number and other criteria

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/account.get_transactions" \  -H "Content-Type: application/json" \  -d '{    "address": "0xb3256026863eb6ae5b06fa396ab09069784ea8ea",    "metadata": "0x5df13a6bf96dbcf6e66d8babd6b55bd40d64d4320c3b115364c6588fc18c2a21",    "txtypes": [      1    ],    "blknum": 68290000,    "limit": 100,    "page": 2  }'
{
  "data": [
    {
      "block": {
        "timestamp": 1540365586,
        "hash": "0x0017372421f9a92bedb7163310918e623557ab5310befc14e67212b660c33bec",
        "eth_height": 97424,
        "blknum": 68290000,
        "inserted_at": "2020-02-10T12:07:32Z",
        "updated_at": "2020-02-15T04:07:57Z"
      },
      "txindex": 0,
      "txtype": 1,
      "txhash": "0x5df13a6bf96dbcf6e66d8babd6b55bd40d64d4320c3b115364c6588fc18c2a21",
      "metadata": "0x00000000000000000000000000000000000000000000000000000048656c6c6f",
      "txbytes": "0x5df13a6bee20000...",
      "inserted_at": "2020-02-10T12:07:32Z",
      "updated_at": "2020-02-15T04:07:57Z",
      "inputs": [
        {
          "blknum": 1000,
          "txindex": 111,
          "otype": 1,
          "oindex": 0,
          "utxo_pos": 1000001110000,
          "owner": "0xb3256026863eb6ae5b06fa396ab09069784ea8ea",
          "currency": "0x0000000000000000000000000000000000000000",
          "creating_txhash": "0x40d65df1c3b1156d813d6bf96d5bd3b5bcf6e6588fc18c2a2ba564c6a64d4320",
          "spending_txhash": "0x5df13a6bf96dbcf6e66d8babd6b55bd40d64d4320c3b115364c6588fc18c2a21",
          "amount": 20000000,
          "inserted_at": "2020-02-10T12:07:32Z",
          "updated_at": "2020-02-15T04:07:57Z"
        }
      ],
      "outputs": [
        {
          "blknum": 68290000,
          "txindex": 5113,
          "otype": 1,
          "oindex": 0,
          "utxo_pos": 68290000051130000,
          "owner": "0xae8ae48796090ba693af60b5ea6be3686206523b",
          "currency": "0x0000000000000000000000000000000000000000",
          "amount": 15000000,
          "creating_txhash": "0x5df13a6bf96dbcf6e66d8babd6b55bd40d64d4320c3b115364c6588fc18c2a21",
          "spending_txhash": null,
          "inserted_at": "2020-02-10T12:07:32Z",
          "updated_at": "2020-02-15T04:07:57Z"
        },
        {
          "blknum": 68290000,
          "txindex": 5113,
          "otype": 1,
          "oindex": 1,
          "utxo_pos": 68290000051130000,
          "owner": "0xb3256026863eb6ae5b06fa396ab09069784ea8ea",
          "currency": "0x0000000000000000000000000000000000000000",
          "amount": 5000000,
          "creating_txhash": "0x5df13a6bf96dbcf6e66d8babd6b55bd40d64d4320c3b115364c6588fc18c2a21",
          "spending_txhash": null,
          "inserted_at": "2020-02-10T12:07:32Z",
          "updated_at": "2020-02-15T04:07:57Z"
        }
      ]
    }
  ],
  "data_paging": {
    "page": 1,
    "limit": 200
  }
}
{
  "success": false,
  "data": {
    "object": "error",
    "code": "server:internal_server_error",
    "description": "Something went wrong on the server",
    "messages": {
      "error_key": "error_reason"
    }
  }
}

Retrieves a single block for the given block number.

POST
/block.get

Intended for operations requiring info for a specific block only. Returns a single block object for the given block number. The returned object includes transaction count but not associated transactions - for which you can use transaction.all with blknum in the request body.

Request Body

application/json

Block number

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/block.get" \  -H "Content-Type: application/json" \  -d '{    "blknum": 68290000  }'
{
  "data": {
    "timestamp": 1540365586,
    "hash": "0x0017372421f9a92bedb7163310918e623557ab5310befc14e67212b660c33bec",
    "eth_height": 97424,
    "blknum": 68290000,
    "tx_count": 2,
    "inserted_at": "2020-02-10T12:07:32Z",
    "updated_at": "2020-02-15T04:07:57Z"
  }
}
{
  "success": false,
  "data": {
    "object": "error",
    "code": "server:internal_server_error",
    "description": "Something went wrong on the server",
    "messages": {
      "error_key": "error_reason"
    }
  }
}

Gets all blocks (can be limited with various filters).

POST
/block.all

Returns a list of blocks ordered by the highest block number first. Intended to be used for presenting an overview of most recent blocks. Note: Due to eventual consistency nature of the informational API, blocks may later than deposits, exits, etc.

Request Body

application/json

The supported request parameters for /block.all

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/block.all" \  -H "Content-Type: application/json" \  -d '{    "page": 2,    "limit": 100  }'
{
  "data": [
    {
      "blknum": 68290000,
      "hash": "0x0017372421f9a92bedb7163310918e623557ab5310befc14e67212b660c33bec",
      "eth_height": 97424,
      "timestamp": 1540365586,
      "tx_count": 2,
      "inserted_at": "2020-02-10T12:07:32Z",
      "updated_at": "2020-02-15T04:07:57Z"
    }
  ],
  "data_paging": {
    "page": 1,
    "limit": 100
  }
}
{
  "success": false,
  "data": {
    "object": "error",
    "code": "server:internal_server_error",
    "description": "Something went wrong on the server",
    "messages": {
      "error_key": "error_reason"
    }
  }
}

Gets a paginated list of deposit for the given address.

POST
/deposit.all

Returns a list of deposits ordered by Ethereum height in descending order for the given address.

Request Body

application/json

The supported request parameters for /deposit.all. The "address" parameter is required.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/deposit.all" \  -H "Content-Type: application/json" \  -d '{    "page": 2,    "limit": 100,    "address": "0xb01cb6f56d798a62d1e0bace406c73a122c39c9d"  }'
{
  "data": [
    {
      "event_type": "deposit",
      "inserted_at": "2020-05-15T12:37:40Z",
      "eth_height": 168637,
      "log_index": 0,
      "root_chain_txhash": "0x63c056f122f5bf30bf8119ec0a2184b73f975951229995a427ea58d904eaab85",
      "txoutputs": [
        {
          "blknum": 1,
          "txindex": 0,
          "otype": 1,
          "oindex": 0,
          "utxo_pos": 1000000000,
          "owner": "0xb3256026863eb6ae5b06fa396ab09069784ea8ea",
          "currency": "0x0000000000000000000000000000000000000000",
          "creating_txhash": null,
          "spending_txhash": "0x5df13a6bf96dbcf6e66d8babd6b55bd40d64d4320c3b115364c6588fc18c2a21",
          "amount": 20000000,
          "inserted_at": "2020-02-10T12:07:32Z",
          "updated_at": "2020-02-10T12:07:32Z"
        }
      ]
    }
  ],
  "data_paging": {
    "page": 1,
    "limit": 100
  }
}
{
  "success": false,
  "data": {
    "object": "error",
    "code": "server:internal_server_error",
    "description": "Something went wrong on the server",
    "messages": {
      "error_key": "error_reason"
    }
  }
}

Gets all transactions (can be limited with various filters).

POST
/transaction.all

Digests the details of the transaction, by listing the value of outputs, aggregated by currency. Intended to be used when presenting the little details about multiple transactions. For all details queries to /transaction.get should be made using the transaction's hash provided.

Request Body

application/json

Account address, block number and other criteria

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/transaction.all" \  -H "Content-Type: application/json" \  -d '{    "address": "0xb3256026863eb6ae5b06fa396ab09069784ea8ea",    "metadata": "0x5df13a6bf96dbcf6e66d8babd6b55bd40d64d4320c3b115364c6588fc18c2a21",    "txtypes": [      1    ],    "blknum": 68290000,    "limit": 100,    "page": 2  }'
{
  "data": [
    {
      "block": {
        "timestamp": 1540365586,
        "hash": "0x0017372421f9a92bedb7163310918e623557ab5310befc14e67212b660c33bec",
        "eth_height": 97424,
        "blknum": 68290000,
        "inserted_at": "2020-02-10T12:07:32Z",
        "updated_at": "2020-02-15T04:07:57Z"
      },
      "txindex": 0,
      "txtype": 1,
      "txhash": "0x5df13a6bf96dbcf6e66d8babd6b55bd40d64d4320c3b115364c6588fc18c2a21",
      "metadata": "0x00000000000000000000000000000000000000000000000000000048656c6c6f",
      "txbytes": "0x5df13a6bee20000...",
      "inserted_at": "2020-02-10T12:07:32Z",
      "updated_at": "2020-02-15T04:07:57Z",
      "inputs": [
        {
          "blknum": 1000,
          "txindex": 111,
          "otype": 1,
          "oindex": 0,
          "utxo_pos": 1000001110000,
          "owner": "0xb3256026863eb6ae5b06fa396ab09069784ea8ea",
          "currency": "0x0000000000000000000000000000000000000000",
          "creating_txhash": "0x40d65df1c3b1156d813d6bf96d5bd3b5bcf6e6588fc18c2a2ba564c6a64d4320",
          "spending_txhash": "0x5df13a6bf96dbcf6e66d8babd6b55bd40d64d4320c3b115364c6588fc18c2a21",
          "amount": 20000000,
          "inserted_at": "2020-02-10T12:07:32Z",
          "updated_at": "2020-02-15T04:07:57Z"
        }
      ],
      "outputs": [
        {
          "blknum": 68290000,
          "txindex": 5113,
          "otype": 1,
          "oindex": 0,
          "utxo_pos": 68290000051130000,
          "owner": "0xae8ae48796090ba693af60b5ea6be3686206523b",
          "currency": "0x0000000000000000000000000000000000000000",
          "amount": 15000000,
          "creating_txhash": "0x5df13a6bf96dbcf6e66d8babd6b55bd40d64d4320c3b115364c6588fc18c2a21",
          "spending_txhash": null,
          "inserted_at": "2020-02-10T12:07:32Z",
          "updated_at": "2020-02-15T04:07:57Z"
        },
        {
          "blknum": 68290000,
          "txindex": 5113,
          "otype": 1,
          "oindex": 1,
          "utxo_pos": 68290000051130000,
          "owner": "0xb3256026863eb6ae5b06fa396ab09069784ea8ea",
          "currency": "0x0000000000000000000000000000000000000000",
          "amount": 5000000,
          "creating_txhash": "0x5df13a6bf96dbcf6e66d8babd6b55bd40d64d4320c3b115364c6588fc18c2a21",
          "spending_txhash": null,
          "inserted_at": "2020-02-10T12:07:32Z",
          "updated_at": "2020-02-15T04:07:57Z"
        }
      ]
    }
  ],
  "data_paging": {
    "page": 1,
    "limit": 200
  }
}
{
  "success": false,
  "data": {
    "object": "error",
    "code": "server:internal_server_error",
    "description": "Something went wrong on the server",
    "messages": {
      "error_key": "error_reason"
    }
  }
}

Finds an optimal way to construct a transaction spending particular amount.

POST
/transaction.create

Given token, amount and spender, finds spender's inputs sufficient to perform a payment. If also provided with receiver's address, creates and encodes a transaction.

Request Body

application/json

The description of transaction to be crafted.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/transaction.create" \  -H "Content-Type: application/json" \  -d '{    "owner": "0xb3256026863eb6ae5b06fa396ab09069784ea8ea",    "payments": [      {        "amount": 100,        "currency": "0x0000000000000000000000000000000000000000",        "owner": "0xae8ae48796090ba693af60b5ea6be3686206523b"      }    ],    "fee": {      "currency": "0x0000000000000000000000000000000000000000"    },    "metadata": "0x5df13a6bf96dbcf6e66d8babd6b55bd40d64d4320c3b115364c6588fc18c2a21"  }'
{
  "data": {
    "result": "complete",
    "transactions": [
      {
        "inputs": [
          {
            "blknum": 123000,
            "txindex": 111,
            "oindex": 0,
            "utxo_pos": 123000001110000,
            "otype": 1,
            "owner": "0xb3256026863eb6ae5b06fa396ab09069784ea8ea",
            "currency": "0x0000000000000000000000000000000000000000",
            "amount": 50,
            "creating_txhash": "0x40d65df1c3b1156d813d6bf96d5bd3b5bcf6e6588fc18c2a2ba564c6a64d4320",
            "spending_txhash": null
          },
          {
            "blknum": 277000,
            "txindex": 2340,
            "oindex": 3,
            "utxo_pos": 277000023400003,
            "otype": 1,
            "owner": "0xb3256026863eb6ae5b06fa396ab09069784ea8ea",
            "currency": "0x0000000000000000000000000000000000000000",
            "amount": 75,
            "creating_txhash": "0x40d65df1c3b1156d813d6bf96d5bd3b5bcf6e6588fc18c2a2ba564c6a64d4320",
            "spending_txhash": null
          }
        ],
        "outputs": [
          {
            "amount": 100,
            "currency": "0x0000000000000000000000000000000000000000",
            "owner": "0xae8ae48796090ba693af60b5ea6be3686206523b"
          },
          {
            "amount": 20,
            "currency": "0x0000000000000000000000000000000000000000",
            "owner": "0xb3256026863eb6ae5b06fa396ab09069784ea8ea"
          }
        ],
        "fee": {
          "amount": 5,
          "currency": "0x0000000000000000000000000000000000000000"
        },
        "metadata": "0x5df13a6bf96dbcf6e66d8babd6b55bd40d64d4320c3b115364c6588fc18c2a21",
        "txbytes": "0x5df13a6bee20000...",
        "sign_hash": "0x7851b951edb0b9e88f0fc80e83461f71d0f4b1d4e44fae7d25a5d4ab6adc5d3d",
        "typed_data": {
          "types": {
            "EIP712Domain": [
              {
                "name": "name",
                "type": "string"
              },
              {
                "name": "version",
                "type": "string"
              },
              {
                "name": "verifyingContract",
                "type": "address"
              },
              {
                "name": "salt",
                "type": "bytes32"
              }
            ],
            "Transaction": [
              {
                "name": "input0",
                "type": "Input"
              },
              {
                "name": "input1",
                "type": "Input"
              },
              {
                "name": "input2",
                "type": "Input"
              },
              {
                "name": "input3",
                "type": "Input"
              },
              {
                "name": "output0",
                "type": "Output"
              },
              {
                "name": "output1",
                "type": "Output"
              },
              {
                "name": "output2",
                "type": "Output"
              },
              {
                "name": "output3",
                "type": "Output"
              },
              {
                "name": "metadata",
                "type": "bytes32"
              }
            ],
            "Input": [
              {
                "name": "blknum",
                "type": "uint256"
              },
              {
                "name": "txindex",
                "type": "uint256"
              },
              {
                "name": "oindex",
                "type": "uint256"
              }
            ],
            "Output": [
              {
                "name": "owner",
                "type": "address"
              },
              {
                "name": "currency",
                "type": "address"
              },
              {
                "name": "amount",
                "type": "uint256"
              }
            ]
          },
          "primaryType": "Transaction",
          "domain": {
            "name": "OMG Network",
            "salt": "0xfad5c7f626d80f9256ef01929f3beb96e058b8b4b0e3fe52d84f054c0e2a7a83",
            "verifyingContract": "0x44de0ec539b8c4a4b530c78620fe8320167f2f74",
            "version": "1"
          },
          "message": {
            "input0": {
              "blknum": 123000,
              "txindex": 111,
              "oindex": 0
            },
            "input1": {
              "blknum": 277000,
              "txindex": 2340,
              "oindex": 3
            },
            "input2": {
              "blknum": 0,
              "txindex": 0,
              "oindex": 0
            },
            "input3": {
              "blknum": 0,
              "txindex": 0,
              "oindex": 0
            },
            "output0": {
              "owner": "0xae8ae48796090ba693af60b5ea6be3686206523b",
              "currency": "0x0000000000000000000000000000000000000000",
              "amount": 100
            },
            "output1": {
              "owner": "0xb3256026863eb6ae5b06fa396ab09069784ea8ea",
              "currency": "0x0000000000000000000000000000000000000000",
              "amount": 20
            },
            "output2": {
              "owner": "0x0000000000000000000000000000000000000000",
              "currency": "0x0000000000000000000000000000000000000000",
              "amount": 0
            },
            "output3": {
              "owner": "0x0000000000000000000000000000000000000000",
              "currency": "0x0000000000000000000000000000000000000000",
              "amount": 0
            },
            "metadata": "0x5df13a6bf96dbcf6e66d8babd6b55bd40d64d4320c3b115364c6588fc18c2a21"
          }
        }
      }
    ]
  }
}
{
  "success": false,
  "data": {
    "object": "error",
    "code": "server:internal_server_error",
    "description": "Something went wrong on the server",
    "messages": {
      "error_key": "error_reason"
    }
  }
}

Gets a transaction with the given id.

POST
/transaction.get

Request Body

application/json

Id (hash) of the transaction

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/transaction.get" \  -H "Content-Type: application/json" \  -d '{    "id": "0x5df13a6bf96dbcf6e66d8babd6b55bd40d64d4320c3b115364c6588fc18c2a21"  }'
{
  "data": {
    "txindex": 5113,
    "txtype": 1,
    "txhash": "0x5df13a6bf96dbcf6e66d8babd6b55bd40d64d4320c3b115364c6588fc18c2a21",
    "metadata": "0x00000000000000000000000000000000000000000000000000000048656c6c6f",
    "txbytes": "0x5df13a6bee20000...",
    "inserted_at": "2020-02-10T12:07:32Z",
    "updated_at": "2020-02-15T04:07:57Z",
    "block": {
      "timestamp": 1540365586,
      "hash": "0x0017372421f9a92bedb7163310918e623557ab5310befc14e67212b660c33bec",
      "eth_height": 97424,
      "blknum": 68290000,
      "inserted_at": "2020-02-10T12:07:32Z",
      "updated_at": "2020-02-15T04:07:57Z"
    },
    "inputs": [
      {
        "blknum": 1000,
        "txindex": 111,
        "oindex": 0,
        "otype": 1,
        "utxo_pos": 1000001110000,
        "owner": "0xb3256026863eb6ae5b06fa396ab09069784ea8ea",
        "currency": "0x0000000000000000000000000000000000000000",
        "amount": 10,
        "creating_txhash": "0x40d65df1c3b1156d813d6bf96d5bd3b5bcf6e6588fc18c2a2ba564c6a64d4320",
        "spending_txhash": "0x5df13a6bf96dbcf6e66d8babd6b55bd40d64d4320c3b115364c6588fc18c2a21",
        "inserted_at": "2020-02-10T12:07:32Z",
        "updated_at": "2020-02-15T04:07:57Z"
      }
    ],
    "outputs": [
      {
        "blknum": 68290000,
        "txindex": 5113,
        "oindex": 0,
        "otype": 1,
        "utxo_pos": 68290000051130000,
        "owner": "0xae8ae48796090ba693af60b5ea6be3686206523b",
        "currency": "0x0000000000000000000000000000000000000000",
        "amount": 2,
        "creating_txhash": "0x5df13a6bf96dbcf6e66d8babd6b55bd40d64d4320c3b115364c6588fc18c2a21",
        "spending_txhash": null,
        "inserted_at": "2020-02-10T12:07:32Z",
        "updated_at": "2020-02-15T04:07:57Z"
      },
      {
        "blknum": 68290000,
        "txindex": 5113,
        "oindex": 1,
        "otype": 1,
        "utxo_pos": 68290000051130000,
        "owner": "0xb3256026863eb6ae5b06fa396ab09069784ea8ea",
        "currency": "0x0000000000000000000000000000000000000000",
        "amount": 7,
        "creating_txhash": "0x5df13a6bf96dbcf6e66d8babd6b55bd40d64d4320c3b115364c6588fc18c2a21",
        "spending_txhash": null,
        "inserted_at": "2020-02-10T12:07:32Z",
        "updated_at": "2020-02-15T04:07:57Z"
      }
    ]
  }
}
{
  "success": false,
  "data": {
    "object": "error",
    "code": "server:internal_server_error",
    "description": "Something went wrong on the server",
    "messages": {
      "error_key": "error_reason"
    }
  }
}

Sends EIP-712 formatted transaction to Child chain.

POST
/transaction.submit_typed

Request to this method is the same as to Web3 eth_signTypedData with additional signatures array. The /transaction.create typed_data field can be used to prepare transaction. The same conditions are met as with security-critical /transaction.submit

Request Body

application/json

Transaction as for eth_signTypedData along with signatures

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/transaction.submit_typed" \  -H "Content-Type: application/json" \  -d '{    "domain": {      "name": "OMG Network",      "salt": "0xfad5c7f626d80f9256ef01929f3beb96e058b8b4b0e3fe52d84f054c0e2a7a83",      "verifyingContract": "0x44de0ec539b8c4a4b530c78620fe8320167f2f74",      "version": "1"    },    "message": {      "input0": {        "blknum": 1,        "txindex": 0,        "oindex": 0      },      "input1": {        "blknum": 1000,        "txindex": 1,        "oindex": 1      },      "input2": {        "blknum": 0,        "txindex": 0,        "oindex": 0      },      "input3": {        "blknum": 0,        "txindex": 0,        "oindex": 0      },      "output0": {        "owner": "0x0527a37aa7081efcf405bd7c8fe36b01e91df27d",        "currency": "0x0000000000000000000000000000000000000000",        "amount": 100      },      "output1": {        "owner": "0x3b9f4c1dd26e0be593373b1d36cee2008cbeb837",        "currency": "0x0000000000000000000000000000000000000000",        "amount": 10      },      "output2": {        "owner": "0x0000000000000000000000000000000000000000",        "currency": "0x0000000000000000000000000000000000000000",        "amount": 0      },      "output3": {        "owner": "0x0000000000000000000000000000000000000000",        "currency": "0x0000000000000000000000000000000000000000",        "amount": 0      },      "metadata": "0x0000000000000000000000000000000000000000000000000000000000000000"    },    "signatures": [      "0x6bfb9b2dbe32..."    ]  }'
{
  "data": {
    "blknum": 123000,
    "txindex": 111,
    "txhash": "0xbdf562c24ace032176e27621073df58ce1c6f65de3b5932343b70ba03c72132d"
  }
}
{
  "success": false,
  "data": {
    "object": "error",
    "code": "server:internal_server_error",
    "description": "Something went wrong on the server",
    "messages": {
      "error_key": "error_reason"
    }
  }
}

This endpoint retrieves the list of fee tokens currently supported by the childchain and the current amount needed to perform a transaction.

POST
/fees.all

Request Body

application/json

An optional array of currencies to filter, raises an error if one of the currencies is not supported.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/fees.all" \  -H "Content-Type: application/json" \  -d '{    "currencies": [      "0x0000000000000000000000000000000000000000"    ],    "tx_types": [      1    ]  }'
{
  "data": {
    "1": [
      {
        "currency": "0x0000000000000000000000000000000000000000",
        "amount": 220000000000000,
        "subunit_to_unit": 1000000000000000000,
        "pegged_currency": "USD",
        "pegged_amount": 4,
        "pegged_subunit_to_unit": 100,
        "updated_at": "2019-01-01T10:10:10+00:00"
      }
    ]
  }
}
{
  "success": false,
  "data": {
    "object": "error",
    "code": "server:internal_server_error",
    "description": "Something went wrong on the server",
    "messages": {
      "error_key": "error_reason"
    }
  }
}

Retrieves network statistics

POST
/stats.get

Retrieves transaction count, block count and average block interval, both for all time and the last 24 hours.

Response Body

application/json

application/json

curl -X POST "https://example.com/stats.get"
{
  "data": {
    "transaction_count": {
      "all_time": 4,
      "last_24_hours": 2
    },
    "block_count": {
      "all_time": 2,
      "last_24_hours": 1
    },
    "average_block_interval": {
      "all_time": 100,
      "last_24_hours": null
    }
  }
}
{
  "success": false,
  "data": {
    "object": "error",
    "code": "server:internal_server_error",
    "description": "Something went wrong on the server",
    "messages": {
      "error_key": "error_reason"
    }
  }
}

Hyperliquid Exchange API

Previous Page

OMG Network Operator API

Next Page