Get venue instruments

GET /venues/{id}/instruments

Returns a list of instruments available for trading on 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

type string

An instrument type enumerator

Values are spot or future.

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 instrument.
  
  type string Required
  
  Values are spot or future.
  
  displayName string Required
  
  feedId string Required
  
  venueSymbol string Required
  
  baseAsset string Required
  
  termAsset string Required
  
  tradingConstraints object
  
  Hide tradingConstraints attributes Show tradingConstraints attributes object
  
  minBaseQty string
  
  maxBaseQty string
  
  minBaseIncrement string
  
  minTermQty string
  
  minPrice string
  
  maxPrice string
  
  minTick string
  
  expiration string(date-time)
  
  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/{id}/instruments

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

Response examples (200)

{
  "data": [
    {
      "id": "BTC-USDT-PERP-BINANCE",
      "resource": "instrument",
      "type": "future",
      "displayName": "BTC-USDT PERP",
      "feedId": "BTC-USDT-PERP-BINANCE",
      "venueSymbol": "BTCUSDT",
      "baseAsset": "BTC",
      "termAsset": "USDT",
      "tradingConstraints": {
        "minBaseQty": "0.001",
        "maxBaseQty": "1000",
        "minBaseIncrement": "0.001",
        "minTermQty": "5",
        "minPrice": "556.72",
        "maxPrice": "1000000",
        "minTick": "0.01"
      },
      "createdAt": "2018-02-19T16:00:00.000Z",
      "updatedAt": "2018-02-19T16:00:00.000Z"
    },
    {
      "id": "BTC-USD-2021-06-25-BINANCE",
      "resource": "instrument",
      "type": "future",
      "displayName": "BTC-USD 2021-06-25",
      "feedId": "BTC-USD-2021-06-25-BINANCE",
      "venueSymbol": "BTCUSD_210625",
      "baseAsset": "BTC",
      "termAsset": "USD",
      "tradingConstraints": {
        "minBaseQty": "1",
        "maxBaseQty": "1000000",
        "minBaseIncrement": "1",
        "minPrice": "1000",
        "maxPrice": "1000000",
        "minTick": "0.1"
      },
      "expiration": "2021-06-25T08:00:00.000Z",
      "createdAt": "2021-04-01T08:00:00.000Z",
      "updatedAt": "2021-04-01T08:00:00.000Z"
    }
  ],
  "meta": {}
}

Response examples (200)

{
  "data": [
    {
      "id": "string",
      "resource": "instrument",
      "type": "spot",
      "displayName": "string",
      "feedId": "string",
      "venueSymbol": "string",
      "baseAsset": "string",
      "termAsset": "string",
      "tradingConstraints": {
        "minBaseQty": "string",
        "maxBaseQty": "string",
        "minBaseIncrement": "string",
        "minTermQty": "string",
        "minPrice": "string",
        "maxPrice": "string",
        "minTick": "string"
      },
      "expiration": "2025-05-04T09:42:00Z",
      "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": {}
}