OMG Network Operator 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"
    }
  }
}
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",
      "network": "RINKEBY"
    }
  ]
}
{
  "success": false,
  "data": {
    "object": "error",
    "code": "server:internal_server_error",
    "description": "Something went wrong on the server",
    "messages": {
      "error_key": "error_reason"
    }
  }
}
POST
/transaction.submit

Normally you should call the Watcher's Transaction - Submit instead of this. The Watcher's version performs various security and validation checks before submitting the transaction, so is much safer. However, if the Watcher is not available this version exists.

Request Body

application/json

Signed transaction RLP-encoded to bytes and HEX-encoded to string

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/transaction.submit" \  -H "Content-Type: application/json" \  -d '{    "transaction": "0xf8d083015ba98080808080940000..."  }'
{
  "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"
    }
  }
}
POST
/block.get

Request Body

application/json

HEX-encoded hash of the block

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 '{    "hash": "0x0017372421f9a92bedb7163310918e623557ab5310befc14e67212b660c33bec"  }'
{
  "data": {
    "blknum": 123000,
    "hash": "0x2733e50f526ec2fa19a22b31e8ed50f23cd1fdf94c9154ed3a7609a2f1ff981f",
    "transactions": [
      "0xf8d083015ba98080808080940000..."
    ]
  }
}
{
  "success": false,
  "data": {
    "object": "error",
    "code": "server:internal_server_error",
    "description": "Something went wrong on the server",
    "messages": {
      "error_key": "error_reason"
    }
  }
}
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"
    }
  }
}