For the complete documentation index, see llms.txt. This page is also available as Markdown.

Quickstart

You need a provisioned originator or searcher account. The account's Ethereum address controls API-key issuance through an EIP-712 signature.

1. Issue an API key

Request a challenge for the account address:

curl "https://orderflow.ethgas.com/v1/auth/challenge?address=0x<ACCOUNT_ADDRESS>"

Sign the returned EIP-712 payload without changing it, then submit the complete challenge, the same top-level address, and the signature:

curl https://orderflow.ethgas.com/v1/auth/verify \
  -H 'Content-Type: application/json' \
  --data '{
    "address": "0x<ACCOUNT_ADDRESS>",
    "domain": { "...": "exact challenge domain" },
    "types": { "...": "exact challenge types" },
    "primaryType": "AuthChallenge",
    "message": { "...": "exact challenge message" },
    "signature": "0x<SIGNATURE>"
  }'

The response contains one ek_live_... API key. Store it securely; keys belong to one account type and are not interchangeable.

2. Submit an originator transaction

The result is the Ethereum transaction hash. The engine forwards accepted orderflow to the configured builders; do not also broadcast the same private flow unless that is intentional.

3. Track it

Tracking returns PENDING, FORWARDED, REJECTED, or UNKNOWN. See Tracking and refunds for bundle and payout queries.

Last updated