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

Obtain an API key

You need to request a partner account first, contact us at info@ethgas.com and share your EOA address.

The account's Ethereum address controls API-key issuance through an EIP-712 signature.

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.

Revoke an API key

To revoke your current API key, send a POST request with the key in the Authorization header and an empty JSON object as the request body:

More details can be found in Orderflow API reference

Last updated