Skip to content

Getting Started

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

Create An Account on Rapid API

To start using the OmniBit API, follow these steps:

  1. Sign Up on Rapid API:
    Visit RapidAPI and create an account if you haven't already.

  2. Subscribe to OmniBit API:
    Once signed in, locate our API and subscribe to gain access. Your subscription provides a unique API key for authentication.

  3. Get Your API Key:
    After subscribing, you'll receive your API key which you'll use in your request header, or just simply pass through Rapid API.

Request and Response Format

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

Success Response Format

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

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

Get started now and unlock the full potential of the OmniBit API for your crypto applications!