> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omnixapi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Make your first OmniX call in under a minute.

## Prerequisites

Before you begin, you need:

* An **OmniX API key** — create one from the [dashboard](https://omnixapi.com/dashboard). New accounts come with free trial credit.
* An **X account token** (`auth_token` cookie) for the account you want to act as. See [Authentication](/authentication).

## Get started

<Steps>
  <Step title="Grab your two credentials">
    Your API key (`omnix_live_...`) and an X `auth_token`. Keep both handy.

    <Note>
      Optional: any call also accepts a **`proxy`** (`http://` or `https://`) to route it
      through your own proxy — add `&proxy=...` to a `GET` URL or a `"proxy"` field to a
      `POST` body. See [Authentication](/authentication#routing-through-a-proxy-optional).
    </Note>
  </Step>

  <Step title="Make your first request (a read)">
    Fetch a user's profile with a simple `GET`:

    <CodeGroup>
      ```bash cURL theme={null}
      curl "https://api.omnixapi.com/api/v1/twitter/user/info?userName=elonmusk&auth_token=YOUR_X_AUTH_TOKEN" \
        -H "Authorization: Bearer omnix_live_xxx"
      ```

      ```js Node.js theme={null}
      const res = await fetch(
        "https://api.omnixapi.com/api/v1/twitter/user/info?userName=elonmusk&auth_token=YOUR_X_AUTH_TOKEN",
        { headers: { Authorization: "Bearer omnix_live_xxx" } }
      );
      console.log((await res.json()).data);
      ```

      ```python Python theme={null}
      import requests
      res = requests.get(
          "https://api.omnixapi.com/api/v1/twitter/user/info",
          params={"userName": "elonmusk", "auth_token": "YOUR_X_AUTH_TOKEN"},
          headers={"Authorization": "Bearer omnix_live_xxx"},
      )
      print(res.json()["data"])
      ```
    </CodeGroup>
  </Step>

  <Step title="Read the response">
    Every response uses the same envelope:

    ```json theme={null}
    {
      "status": true,
      "data": { "id": "44196397", "userName": "elonmusk", "name": "Elon Musk" },
      "error": null
    }
    ```

    * `status` — `true` on success, `false` on error.
    * `data` — the payload (documented per endpoint).
    * `error` — `null` on success, otherwise the message.
  </Step>

  <Step title="Post your first tweet (a write)">
    Now a `POST` that acts on your account:

    ```bash theme={null}
    curl -X POST "https://api.omnixapi.com/api/v1/twitter/tweet/create" \
      -H "Authorization: Bearer omnix_live_xxx" \
      -H "Content-Type: application/json" \
      -d '{ "auth_token": "YOUR_X_AUTH_TOKEN", "text": "Hello from OmniX 👋" }'
    ```
  </Step>
</Steps>

<Tip>
  Prefer clicking over copying? Open any endpoint in the **API Reference**, paste
  your API key and `auth_token`, and hit **Send** to run it live against your
  account.
</Tip>