Get ticker by symbol

GET /tickers/:symbol

Get market data for contract or index by symbol

Request

Path Parameters

symbol MarketSymbolrequired

Possible values: Value must match regular expression [A-Z0-9_.]+

Market symbol.

Responses

application/json

Schema
Example (from schema)
success

Schema

ticker object required

oneOf

Market Ticker
Index Ticker

symbol MarketSymbol (string)required

Possible values: Value must match regular expression [A-Z0-9_.]+

Market symbol

last double

The price of the last fill.

lastTime string

The date and time at which last was observed.

lastSize number

The size of the last fill.

tag stringrequired

Possible values: [perpetual, month, quarter, semiannual]

Expiry-related grouping.

Currently can be 'perpetual', 'month', 'quarter', or 'semiannual'. Other tags may be added without notice.

pair stringrequired

The currency pair of the instrument.

markPrice numberrequired

The price to which Kraken Futures currently marks the Futures for margining purposes.

bid number

The price of the current best bid.

bidSize number

The size of the current best bid.

ask number

The price of the current best ask.

askSize number

The size of the current best ask.

vol24h numberrequired

The sum of the sizes of all fills observed in the last 24 hours.

volumeQuote numberrequired

The sum of the size * price of all fills observed in the last 24 hours.

openInterest numberrequired

The current open interest of the market.

open24h number

The price of the fill observed 24 hours ago.

high24h number

The highest fill price observed in the last 24 hours.

low24h number

The lowest fill price observed in the last 24 hours.

extrinsicValue number

The mark price less the how much the option would be worth if exercised now, i.e.:

For a call: markPrice - ( max ( Underlying - StrikePrice , 0) )
For a put: markPrice - ( max ( StrikePrice - Underlying , 0) )

Only returned for options markets.

fundingRate number

The current absolute funding rate.

Only returned for perpetual markets.

fundingRatePrediction number

The estimated next absolute funding rate.

Only returned for perpetual markets.

suspended booleanrequired

True if the market is suspended.

indexPrice numberrequired

postOnly booleanrequired

change24h numberrequired

The 24h change in price (%).

greeks object

Current greeks.

Only returned for options markets.

iv doublerequired

The implied volatility.

delta doublerequired

gamma double

vega double

theta double

rho double

isUnderlyingMarketClosed boolean

True if the underlying market/index is closed.

Only returned for tradfi markets.

symbol stringrequired

The symbol of the index.

last number

The last calculated value.

lastTime date-time

The date and time at which last was observed.

result stringrequired

Possible values: [success]

serverTime date-timerequired

Server time in Coordinated Universal Time (UTC)

{
  "ticker": {
    "symbol": "PF_BTCUSD",
    "last": 12.03532,
    "lastTime": "string",
    "lastSize": 0,
    "tag": "perpetual",
    "pair": "BTC:USD",
    "markPrice": 0,
    "bid": 0,
    "bidSize": 0,
    "ask": 0,
    "askSize": 0,
    "vol24h": 0,
    "volumeQuote": 0,
    "openInterest": 0,
    "open24h": 0,
    "high24h": 0,
    "low24h": 0,
    "extrinsicValue": 0,
    "fundingRate": 0,
    "fundingRatePrediction": 0,
    "suspended": true,
    "indexPrice": 0,
    "postOnly": true,
    "change24h": 0,
    "greeks": {
      "iv": 0,
      "delta": 0,
      "gamma": 0,
      "vega": 0,
      "theta": 0,
      "rho": 0
    },
    "isUnderlyingMarketClosed": true
  },
  "result": "success",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

{
  "result": "success",
  "ticker": {
    "tag": "perpetual",
    "pair": "XBT:USD",
    "symbol": "pi_xbtusd",
    "markPrice": 30209.9,
    "bid": 8634,
    "bidSize": 1000,
    "ask": 49289,
    "askSize": 139984,
    "vol24h": 15304,
    "volumeQuote": 40351.34,
    "change24h": 1.9974017538161748,
    "openInterest": 149655,
    "open24h": 49289,
    "indexPrice": 21087.8,
    "last": 49289,
    "lastTime": "2022-06-17T10:46:35.705Z",
    "lastSize": 100,
    "suspended": false,
    "fundingRate": 1.18588737106e-7,
    "fundingRatePrediction": 1.1852486794e-7,
    "postOnly": false
  },
  "serverTime": "2022-06-17T11:00:31.335Z"
}

Contract could not be found

application/json

Schema
Example (from schema)

Schema

errors Error (string)[]

Possible values: [accountInactive, apiLimitExceeded, authenticationError, insufficientFunds, invalidAccount, invalidAmount, invalidArgument, invalidUnit, Json Parse Error, marketUnavailable, nonceBelowThreshold, nonceDuplicate, notFound, requiredArgumentMissing, Server Error, Unavailable, unknownError]

error Error (string)required

Error description.

accountInactive: The Futures account the request refers to is inactive
apiLimitExceeded: The API limit for the calling IP address has been exceeded
authenticationError: The request could not be authenticated
insufficientFunds: The amount requested for transfer is below the amount of funds available
invalidAccount: The Futures account the transfer request refers to is invalid
invalidAmount: The amount the transfer request refers to is invalid
invalidArgument: One or more arguments provided are invalid
invalidUnit: The unit the transfer request refers to is invalid
Json Parse Error: The request failed to pass valid JSON as an argument
marketUnavailable: The market is currently unavailable
nonceBelowThreshold: The provided nonce is below the threshold
nonceDuplicate: The provided nonce is a duplicate as it has been used in a previous request
notFound: The requested information could not be found
requiredArgumentMissing: One or more required arguments are missing
Server Error: There was an error processing the request
Unavailable: The endpoint being called is unavailable
unknownError: An unknown error has occurred

result stringrequired

Possible values: [error]

serverTime date-timerequired

Server time in Coordinated Universal Time (UTC)

{
  "errors": [
    "accountInactive"
  ],
  "error": "accountInactive",
  "result": "error",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Get ticker by symbol

/tickers/:symbol

Request​

Path Parameters

Responses​

Request

Responses