Skip to Content
SDK ReferenceREST APIRelayer
REST API

HTTP API exposed by every zkScatter relayer node. Apps use this to discover a relayer's identity and fee, submit signed orders, fetch order status, and cancel. All relayers implement the same surface — switch the base URL to switch operators.

zkScatter Relayer API

Serverhttps://relayer.example.comProduction relayer (replace with a registered operator's URL — see `RelayerRegistry`).

Endpoints

GET/api/info
Relayer identity, fee, and pending-queue depth

Relayer identity, fee, and pending-queue depth

GET/api/info

Returns the operator's identity, on-chain fee (in basis points), and the number of pending authorize orders. Apps use this to filter the on-chain registry list down to operators that are actually online and matching.

Responses

200Relayer info
RelayerApiInfo
namestringrequired

Human-readable relayer name. Matches what the operator advertises on-chain.

example: "ScatterDEX ZK Relayer"

versionstringrequired

Relayer software version. Use to gate features that require a specific server build.

example: "0.1.0"

addressstringrequired

Operator EOA — must match the address registered in `RelayerRegistry`. Apps cross-check this against the on-chain record before submitting.

example: "0xabcdef0123456789abcdef0123456789abcdef01"

feeintegerrequired

Per-trade fee in basis points (100 = 1%). Must equal the on-chain `fee` field.

example: 30

orderCountintegerrequired

Number of pending authorize orders the relayer is currently holding.

example: 12

commitmentPoolstringrequired

Address of the `CommitmentPool` contract this relayer matches against.

privateSettlementstringrequired

Address of the `PrivateSettlement` contract this relayer submits to.

profileobject

Operator-set cosmetic metadata. Untrusted by the SDK — every consumer must run it through `sanitizeProfile` before rendering.

namestring
descriptionstring
logoUrlstring
contactstring
socialXstring
websitestring
updatedAtinteger

Unix seconds since the operator last edited the profile.

Example

curl --request GET \
  --url https://relayer.example.com/api/info
{
  "name": "ScatterDEX ZK Relayer",
  "version": "0.1.0",
  "address": "0xabcdef0123456789abcdef0123456789abcdef01",
  "fee": 30,
  "orderCount": 12,
  "commitmentPool": "string",
  "privateSettlement": "string",
  "profile": {
    "name": "string",
    "description": "string",
    "logoUrl": "string",
    "contact": "string",
    "socialX": "string",
    "website": "string",
    "updatedAt": 0
  }
}
react