OmniBit API Documentation¶

Welcome to the OmniBit API! This guide will help you quickly set up and integrate our powerful crypto market data services.

Authentication¶

OmniBit API now supports its own authentication system. When making requests, include your unique API key in the request header as follows:

X-OMNI-API-KEY: {your_api_key}

Base URL¶

All API requests should be directed to the following base URL:

https://omnibit1.aio.exchange

Make sure to append the specific endpoint paths to this base URL in your requests

Create An Account and Get Started¶

You have two options to get started with the OmniBit API:

Sign Up Directly on OmniBit:
Visit OmniBit and create an account. Once signed up, you'll receive a unique API key for authentication. Remember to include the X-OMNI-API-KEY header with your requests.
Or Subscribe via Rapid API (Optional):
If you prefer, you can still sign up on RapidAPI and subscribe to our API. Regardless of the method chosen, you must include your API key with every request.

Request and Response Format¶

Our API uses JSON for both requests and responses. Below is the standard response format:

Success Response Format¶

json

{
  "data": {
    "balance": 142.922878,
    "network": "TRON",
    "symbol": "TRX"
  },
  "success": true,
  "timestamp": 1740543825582,
  "requestId": "c7a1f7b8-2d48-4e73-b19a-68a2e8dfb123",
  "message": "",
  "error": null
}

Error Response Format¶

If an error occurs, the error field will contain an object with details about the issue.

json

{
  "data": null,
  "success": false,
  "timestamp": 1742298908040,
  "requestId": "f6b07247-2f38-466e-915b-0f798502354c",
  "message": "An error occurred.",
  "error": {
    "isError": true,
    "message": "Invalid symbols provided."
  }
}

Response Fields¶

Field	Type	Description
`data`	`object` or `array`	Contains the response data when the request is successful. If an error occurs, this will be `null`.
`success`	`boolean`	`true` if the request was successful, `false` otherwise.
`timestamp`	`integer`	Epoch timestamp indicating when the response was generated.
`requestId`	`string`	Unique identifier for the request, useful for debugging.
`message`	`string`	Optional message providing additional information (typically empty).
`error`	`object` or `null`	Contains error details when `success` is `false`.

This standardized format ensures consistency across all endpoints, making integration and debugging easier.

Token Reference and Identification¶

Our API supports two methods for token identification:

By Ticker Symbol:
Quick to use but can be ambiguous since multiple tokens might share the same symbol.
By Token ID (Recommended):
Provides a unique identifier for each token, eliminating ambiguity. Use this method for precise operations.

For example, when converting tokens you can choose:

By Symbol:

GET /v1/convert/symbols/ETH/BTC

By Token ID:

GET /v1/convert/{baseTokenId}/{targetTokenId}

If you are unsure about a token’s ID, consult the token mapping endpoint:

GET /v1/metadata/tokenmap

This endpoint returns a comprehensive mapping of token IDs to their corresponding ticker symbols.