Get venues

GET /venues

Returns a list of venues available for trading.

Headers

ONX-API-KEY string Required

An API key assigned by Omniex
ONX-API-TIMESTAMP integer(int64) Required

Unix timestamp value, in milliseconds
ONX-API-SIGNATURE string Required

The signature generated for this API call

Query parameters

id string

A comma-separated list of Omniex-assigned venue identifiers
include string

Expand the returned venue objects

Value is instruments.

Responses

200

success
Hide response attributes Show response attributes object
- data array[object] Required
  
  Hide data attributes Show data attributes array[object]
  
  id string Required
  
  resource string Required
  
  Value is venue.
  
  type array[string] Required
  
  Values are exchange, otc, or custodian.
  
  displayName string Required
  
  tradingStatus string Required
  
  Values are trading, suspended, or unsupported.
  
  instruments array[object]
  
  Hide instruments attributes Show instruments attributes array[object]
  
  id string Required
  
  type string Required
  
  Values are spot or future.
  
  displayName string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
- meta object Required
400

bad request
Hide response attributes Show response attributes object
- errors array[object] Required
  
  Hide errors attributes Show errors attributes array[object]
  
  error string Required
  
  Values are ACCESS_DENIED, AUTHENTICATION_FAILED, INTERNAL_SERVER_ERROR, METHOD_UNSUPPORTED, PARAMETER_INVALID, PARAMETER_UNSUPPORTED, RESOURCE_NOT_FOUND, or TIMESTAMP_INVALID.
  
  message string Required
- meta object Required
401

unauthorized
Hide response attributes Show response attributes object
- errors array[object] Required
  
  Hide errors attributes Show errors attributes array[object]
  
  error string Required
  
  Values are ACCESS_DENIED, AUTHENTICATION_FAILED, INTERNAL_SERVER_ERROR, METHOD_UNSUPPORTED, PARAMETER_INVALID, PARAMETER_UNSUPPORTED, RESOURCE_NOT_FOUND, or TIMESTAMP_INVALID.
  
  message string Required
- meta object Required

GET /venues

curl \
 -X GET https://api.omniex.io/edge/v1beta/venues \
 -H "ONX-API-KEY: fI7xlbw7e2" \
 -H "ONX-API-TIMESTAMP: 1606940938725" \
 -H "ONX-API-SIGNATURE: 3181a3c21da8a5bb952076cc3655cc17de3d63efa790282c3625d21fee52db4a"

Response examples (200)

{
  "data": [
    {
      "id": "binance",
      "resource": "venue",
      "type": [
        "exchange"
      ],
      "displayName": "Binance",
      "tradingStatus": "trading",
      "instruments": [
        {
          "id": "BTC/USDT",
          "type": "spot",
          "displayName": "BTC/USDT"
        },
        {
          "id": "BTC-USDT-PERP-BINANCE",
          "type": "future",
          "displayName": "BTC-USDT PERP"
        },
        {
          "id": "BTC-USD-2021-06-25-BINANCE",
          "type": "future",
          "displayName": "BTC-USD 2021-06-25"
        }
      ],
      "createdAt": "2021-04-12T22:53:27.524Z",
      "updatedAt": "2021-04-12T22:53:27.524Z"
    },
    {
      "id": "galaxy",
      "resource": "venue",
      "type": [
        "otc"
      ],
      "displayName": "Galaxy",
      "tradingStatus": "trading",
      "instruments": [
        {
          "id": "BTC/USD",
          "type": "spot",
          "displayName": "BTC/USD"
        }
      ],
      "createdAt": "2021-04-19T22:53:27.524Z",
      "updatedAt": "2021-04-19T22:53:27.524Z"
    },
    {
      "id": "gdax",
      "resource": "venue",
      "type": [
        "exchange"
      ],
      "displayName": "Coinbase",
      "tradingStatus": "suspended",
      "instruments": [
        {
          "id": "BTC/USD",
          "type": "spot",
          "displayName": "BTC/USD"
        },
        {
          "id": "ETH/USD",
          "type": "spot",
          "displayName": "ETH/USD"
        }
      ],
      "createdAt": "2021-04-13T22:53:27.524Z",
      "updatedAt": "2021-04-19T10:17:51.980Z"
    }
  ],
  "meta": {}
}

Response examples (200)

{
  "data": [
    {
      "id": "string",
      "resource": "venue",
      "type": [
        "exchange"
      ],
      "displayName": "string",
      "tradingStatus": "trading",
      "instruments": [
        {
          "id": "string",
          "type": "spot",
          "displayName": "string"
        }
      ],
      "createdAt": "2025-05-04T09:42:00Z",
      "updatedAt": "2025-05-04T09:42:00Z"
    }
  ],
  "meta": {}
}

Response examples (400)

{
  "errors": [
    {
      "error": "PARAMETER_VALUE_INVALID",
      "message": "a specified query/path parameter value was invalid"
    }
  ],
  "meta": {}
}

{
  "errors": [
    {
      "error": "PARAMETER_UNSUPPORTED",
      "message": "a specified query parameter is unsupported"
    }
  ],
  "meta": {}
}

{
  "errors": [
    {
      "error": "TIMESTAMP_INVALID",
      "message": "the request timestamp is invalid or outside the required window"
    }
  ],
  "meta": {}
}

Response examples (400)

{
  "errors": [
    {
      "error": "ACCESS_DENIED",
      "message": "string"
    }
  ],
  "meta": {}
}

Response examples (401)

{
  "errors": [
    {
      "error": "AUTHENTICATION_FAILED",
      "message": "the api server failed to authenticate the request"
    }
  ],
  "meta": {}
}

Response examples (401)

{
  "errors": [
    {
      "error": "ACCESS_DENIED",
      "message": "string"
    }
  ],
  "meta": {}
}

Get venue by venue ID

GET /venues/{id}

Returns the specified venue.

Headers

ONX-API-KEY string Required

An API key assigned by Omniex
ONX-API-TIMESTAMP integer(int64) Required

Unix timestamp value, in milliseconds
ONX-API-SIGNATURE string Required

The signature generated for this API call

Path parameters

id string Required

An Omniex-assigned venue identifier

Query parameters

include string

Expand the returned venue objects

Value is instruments.

Responses

200

success
Hide response attributes Show response attributes object
- meta object Required
- data object Required
  
  Hide data attributes Show data attributes object
  
  type array[string] Required
  
  Values are exchange, otc, or custodian.
  
  displayName string Required
  
  tradingStatus string Required
  
  Values are trading, suspended, or unsupported.
  
  instruments array[object]
  
  Hide instruments attributes Show instruments attributes array[object]
  
  id string Required
  
  type string Required
  
  Values are spot or future.
  
  displayName string Required
  
  createdAt string(date-time) Required
  
  updatedAt string(date-time) Required
  
  id string Required
  
  resource string Required
  
  Value is venue.
400

bad request
Hide response attributes Show response attributes object
- errors array[object] Required
  
  Hide errors attributes Show errors attributes array[object]
  
  error string Required
  
  Values are ACCESS_DENIED, AUTHENTICATION_FAILED, INTERNAL_SERVER_ERROR, METHOD_UNSUPPORTED, PARAMETER_INVALID, PARAMETER_UNSUPPORTED, RESOURCE_NOT_FOUND, or TIMESTAMP_INVALID.
  
  message string Required
- meta object Required
401

unauthorized
Hide response attributes Show response attributes object
- errors array[object] Required
  
  Hide errors attributes Show errors attributes array[object]
  
  error string Required
  
  Values are ACCESS_DENIED, AUTHENTICATION_FAILED, INTERNAL_SERVER_ERROR, METHOD_UNSUPPORTED, PARAMETER_INVALID, PARAMETER_UNSUPPORTED, RESOURCE_NOT_FOUND, or TIMESTAMP_INVALID.
  
  message string Required
- meta object Required

GET /venues/{id}

curl \
 -X GET https://api.omniex.io/edge/v1beta/venues/binance \
 -H "ONX-API-KEY: fI7xlbw7e2" \
 -H "ONX-API-TIMESTAMP: 1606940938725" \
 -H "ONX-API-SIGNATURE: 3181a3c21da8a5bb952076cc3655cc17de3d63efa790282c3625d21fee52db4a"

Response examples (200)

{
  "data": {
    "id": "binance",
    "resource": "venue",
    "type": [
      "exchange"
    ],
    "displayName": "Binance",
    "tradingStatus": "trading",
    "instruments": [
      {
        "id": "BTC/USDT",
        "type": "spot",
        "displayName": "BTC/USDT"
      },
      {
        "id": "BTC-USDT-PERP-BINANCE",
        "type": "future",
        "displayName": "BTC-USDT PERP"
      },
      {
        "id": "BTC-USD-2021-06-25-BINANCE",
        "type": "future",
        "displayName": "BTC-USD 2021-06-25"
      }
    ],
    "createdAt": "2021-04-12T22:53:27.524Z",
    "updatedAt": "2021-04-12T22:53:27.524Z"
  },
  "meta": {}
}

Response examples (200)

{
  "meta": {},
  "data": {
    "type": [
      "exchange"
    ],
    "displayName": "string",
    "tradingStatus": "trading",
    "instruments": [
      {
        "id": "string",
        "type": "spot",
        "displayName": "string"
      }
    ],
    "createdAt": "2025-05-04T09:42:00Z",
    "updatedAt": "2025-05-04T09:42:00Z",
    "id": "string",
    "resource": "venue"
  }
}

Response examples (400)

{
  "errors": [
    {
      "error": "PARAMETER_VALUE_INVALID",
      "message": "a specified query/path parameter value was invalid"
    }
  ],
  "meta": {}
}

{
  "errors": [
    {
      "error": "PARAMETER_UNSUPPORTED",
      "message": "a specified query parameter is unsupported"
    }
  ],
  "meta": {}
}

{
  "errors": [
    {
      "error": "TIMESTAMP_INVALID",
      "message": "the request timestamp is invalid or outside the required window"
    }
  ],
  "meta": {}
}

Response examples (400)

{
  "errors": [
    {
      "error": "ACCESS_DENIED",
      "message": "string"
    }
  ],
  "meta": {}
}

Response examples (401)

{
  "errors": [
    {
      "error": "AUTHENTICATION_FAILED",
      "message": "the api server failed to authenticate the request"
    }
  ],
  "meta": {}
}

Response examples (401)

{
  "errors": [
    {
      "error": "ACCESS_DENIED",
      "message": "string"
    }
  ],
  "meta": {}
}