> For the complete documentation index, see [llms.txt](https://docs.ethgas.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ethgas.com/orderflow/quickstart.md).

# 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:

```bash
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:

```bash
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.

{% hint style="warning" %}
Issuing a new key rotates the account's active key. Never put API keys, private keys, signed transactions, or authorization headers in logs.
{% endhint %}

## 2. Submit an originator transaction

```bash
curl https://originator.orderflow.ethgas.com/v1/<API_KEY> \
  -H 'Content-Type: application/json' \
  --data '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "eth_sendRawTransaction",
    "params": ["0x<SIGNED_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

```bash
curl https://orderflow.ethgas.com/v1/tx/0x<TRANSACTION_HASH>
```

Tracking returns `PENDING`, `FORWARDED`, `REJECTED`, or `UNKNOWN`. See [Tracking and refunds](/orderflow/tracking-and-refunds.md) for bundle and payout queries.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.ethgas.com/orderflow/quickstart.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.