Quickstart - OmniX

Prerequisites

Before you begin, you need:

An OmniX API key — create one from the 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.

Get started

Grab your two credentials

Your API key (omnix_live_...) and an X auth_token. Keep both handy.

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.

Make your first request (a read)

Fetch a user’s profile with a simple GET:

curl "https://api.omnixapi.com/api/v1/twitter/user/info?userName=elonmusk&auth_token=YOUR_X_AUTH_TOKEN" \
  -H "Authorization: Bearer omnix_live_xxx"

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);

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"])

Read the response

Every response uses the same envelope:

{
  "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.

Post your first tweet (a write)

Now a POST that acts on your account:

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 👋" }'

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.

​Prerequisites

​Get started

Prerequisites

Get started