Join our community of builders on

Telegram!Telegram

Relayer routes implementation

Development Documentation

You're viewing documentation for unreleased features from the main branch. For production use, see the latest stable version (v1.1.x).

Note: OpenAPI documentation for these endpoints can be found in the openapi.rs file

Lists all relayers with pagination support.

GET
/api/v1/relayers
AuthorizationBearer <token>

In: header

Query Parameters

page?integer

Page number for pagination (starts at 1)

Range0 <= value
per_page?integer

Number of items per page (default: 10)

Range0 <= value

Response Body

curl -X GET "https://loading/api/v1/relayers?page=0&per_page=0"
{
  "data": [
    {
      "address": "string",
      "custom_rpc_urls": [
        {
          "url": "string",
          "weight": 0
        }
      ],
      "disabled_reason": {
        "details": "string",
        "type": "NonceSyncFailed"
      },
      "id": "string",
      "name": "string",
      "network": "string",
      "network_type": "evm",
      "notification_id": "string",
      "paused": true,
      "policies": {
        "eip1559_pricing": true,
        "gas_limit_estimation": true,
        "gas_price_cap": 0,
        "min_balance": 0,
        "private_transactions": true,
        "whitelist_receivers": [
          "string"
        ]
      },
      "signer_id": "string",
      "system_disabled": true
    }
  ],
  "error": "string",
  "metadata": {
    "logs": [
      {
        "level": "log",
        "message": "string"
      }
    ],
    "traces": [
      null
    ]
  },
  "pagination": {
    "current_page": 0,
    "per_page": 0,
    "total_items": 0
  },
  "success": true
}
{
  "data": null,
  "message": "Bad Request",
  "success": false
}
{
  "data": null,
  "message": "Unauthorized",
  "success": false
}
{
  "data": null,
  "message": "Too Many Requests",
  "success": false
}
{
  "data": null,
  "message": "Internal Server Error",
  "success": false
}