Skip to content

Relayer API Keys

Relayer API Keys are stored in the relayer_api_keys table and validated through request headers at submission time.

HeaderDescription
RELAYER_API_KEYThe relayer API key
RELAYER_API_KEY_ADDRESSThe address associated with the API key

When submitting a relay transaction through POST /submit, you have two authentication options:

  1. Relayer API Key — Include the RELAYER_API_KEY and RELAYER_API_KEY_ADDRESS headers
  2. L2 HMAC — Include the standard OPENFISH_* authentication headers

The server checks for Relayer API Key credentials first. If those headers are present, it validates the key against the relayer_api_keys table. When they are absent, the server falls back to L2 HMAC authentication.

Builder-specific endpoints (POST /builder/order, POST /builder/cancel) support an additional key-based authentication path via the OPENFISH_BUILDER_API_KEY header. When supplied, this key is verified against the builder_api_keys table.

HeaderDescription
OPENFISH_BUILDER_IDBuilder identifier (required for all builder endpoints)
OPENFISH_BUILDER_API_KEYOptional builder API key for authentication