openapi: 3.0.0 info: title: Deribit Account Management Public API version: 2.1.1 description: Public methods can be used without authentication. servers: - url: https://test.deribit.com/api/v2 tags: - name: Public description: Public methods can be used without authentication. paths: /public/get_announcements: get: parameters: - name: start_timestamp in: query schema: $ref: '#/components/schemas/timestamp' default: Current time description: The most recent timestamp to return the results for (milliseconds since the UNIX epoch) required: false - name: count in: query schema: type: integer default: 5 example: 10 maximum: 50 minimum: 1 description: Maximum count of returned announcements, default - `5`, maximum - `50` required: false responses: '200': $ref: '#/components/responses/PublicGetAnnouncementsResponse' tags: - Public requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 7661 method: public/get_announcements params: {} description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves platform announcements and important notices. Announcements include system updates, maintenance schedules, new features, policy changes, and other important information. Results are returned in reverse chronological order (newest first). The default `start_timestamp` is the current time, and the `count` parameter must be between 1 and 50 (default is 5). [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_announcements) ' x-mint: metadata: title: public/get_announcements og:title: public/get_announcements keywords: - public/get_announcements - start_timestamp - count - body - publication_timestamp - important - confirmation - title href: /api-reference/account-management/public-get_announcements /public/auth: get: tags: - Public parameters: - name: grant_type in: query schema: type: string enum: - client_credentials - client_signature - refresh_token example: client_credentials required: true description: Method of authentication - name: client_id in: query schema: type: string example: fo7WAPRm4P required: true description: Required for grant type `` `client_credentials` `` and `` `client_signature` `` - name: client_secret in: query schema: type: string example: W0H6FJW4IRPZ1MOQ8FP6KMC5RZDUUKXS required: true description: Required for grant type `` `client_credentials` `` - name: refresh_token in: query schema: type: string required: true description: Required for grant type `` `refresh_token` `` - name: timestamp in: query schema: type: integer required: true description: 'Required for grant type `` `client_signature` ``. Provides time when request has been generated (milliseconds since the UNIX epoch). ' - name: signature in: query schema: type: string required: true description: 'Required for grant type `` `client_signature` ``. It''s a cryptographic signature calculated over provided fields using user **secret key**. The signature should be calculated as an HMAC (Hash-based Message Authentication Code) with `` `SHA256` `` hash algorithm. ' - name: nonce in: query schema: type: string description: 'Optional for grant type `` `client_signature` ``. Delivers user generated initialization vector for the server token. ' required: false - name: data in: query schema: type: string description: 'Optional for grant type `` `client_signature` ``. Contains any user specific value. ' required: false - name: state in: query schema: type: string description: Will be passed back in the response. required: false - name: scope in: query schema: type: string example: connection description: 'Describes type of the access for assigned token. **Possible values:** - `` `connection` `` - `` `session:name` `` - `` `trade:[read, read_write, none]` `` - `` `wallet:[read, read_write, none]` `` - `` `account:[read, read_write, none]` `` - `` `expires:NUMBER` `` - `` `ip:ADDR` `` Details are elucidated in [Access scope](https://docs.deribit.com/articles/access-scope) ' required: false responses: '200': $ref: '#/components/responses/PublicAuthResponse' requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 9929 method: public/auth params: grant_type: client_credentials client_id: fo7WAPRm4P client_secret: W0H6FJW4IRPZ1MOQ8FP6KMC5RZDUUKXS description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieve an OAuth access token, to be used for authentication of ''private'' requests. **📖 Related Article:** [Authentication](https://docs.deribit.com/articles/authentication) **Authentication Methods:** Three methods of authentication are supported: - ``client_credentials`` - Using the client id and client secret that can be found on the API page on the website. This is the simplest method, suitable for server-to-server applications and quick setup. - ``client_signature`` - Enhanced security method that uses a cryptographic signature instead of sending the client secret directly. You generate an HMAC-SHA256 signature of a string containing a timestamp, a random nonce, and optional data, using your Client Secret as the key. This method requires `` `client_id` ``, `` `timestamp` `` (current time in milliseconds), `` `nonce` ``, `` `signature` ``, and optionally a `` `data` `` field. Deribit verifies the signature instead of requiring the raw secret. Best for enhanced security, asymmetric key pairs, and avoiding secret transmission. See the [Client Signature (WebSocket) guide](https://docs.deribit.com/articles/authentication#client-signature-websocket) for detailed signature calculation instructions. - ``refresh_token`` - Using a refresh token that was received from an earlier invocation. This allows you to obtain a new access token without re-supplying your Client ID and Client Secret. Best for long-lived sessions, token renewal, and avoiding re-authentication. **Response:** The response will contain an access token, expiration period (number of seconds that the token is valid) and a refresh token that can be used to get a new set of tokens. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fauth) ' x-mint: metadata: title: public/auth og:title: public/auth keywords: - public/auth - grant_type - client_id - client_secret - refresh_token - timestamp - signature - nonce - data - state - scope - access_token - token_type - expires_in - sid - enabled_features - mandatory_tfa_status - google_login href: /api-reference/authentication/public-auth /public/exchange_token: get: tags: - Public parameters: - name: refresh_token in: query schema: type: string example: 1568800656974.1CWcuzUS.MGy49NK4hpTwvR1OYWfpqMEkH4T4oDg4tNIcrM7KdeyxXRcSFqiGzA_D4Cn7mqWocHmlS89FFmUYcmaN2H7lNKKTnhRg5EtrzsFCCiuyN0Wv9y-LbGLV3-Ojv_kbD50FoScQ8BDXS5b_w6Ir1MqEdQ3qFZ3MLcvlPiIgG2BqyJX3ybYnVpIlrVrrdYD1-lkjLcjxOBNJvvUKNUAzkQ required: true description: Refresh token - name: subject_id in: query schema: type: integer example: 10 required: true description: New subject id - name: scope in: query schema: type: string required: false description: Optional scope override for the new session. Cannot exceed caller's permissions. Supports `session` scope for direct session creation during token exchange. responses: '200': $ref: '#/components/responses/PublicTokenResponse' requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 7619 method: public/exchange_token params: refresh_token: 1568800656974.1CWcuzUS.MGy49NK4hpTwvR1OYWfpqMEkH4T4oDg4tNIcrM7KdeyxXRcSFqiGzA_D4Cn7mqWocHmlS89FFmUYcmaN2H7lNKKTnhRg5EtrzsFCCiuyN0Wv9y-LbGLV3-Ojv_kbD50FoScQ8BDXS5b_w6Ir1MqEdQ3qFZ3MLcvlPiIgG2BqyJX3ybYnVpIlrVrrdYD1-lkjLcjxOBNJvvUKNUAzkQ subject_id: 10 description: JSON-RPC Request Example description: JSON-RPC request body description: "Generates a token for a new subject id. This method can be used to switch between subaccounts.\n\n**\U0001F4D6 Related Articles:** \n- [Fork and Exchange Tokens](https://docs.deribit.com/articles/authentication#fork-and-exchange-tokens)\n- [Managing Subaccounts](https://docs.deribit.com/articles/managing-subaccounts-api)\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fexchange_token)\n\n" x-mint: metadata: title: public/exchange_token og:title: public/exchange_token keywords: - public/exchange_token - refresh_token - subject_id - scope - access_token - token_type - expires_in - sid href: /api-reference/authentication/public-exchange_token /public/fork_token: get: tags: - Public parameters: - name: refresh_token in: query schema: type: string example: 1568800656974.1CWcuzUS.MGy49NK4hpTwvR1OYWfpqMEkH4T4oDg4tNIcrM7KdeyxXRcSFqiGzA_D4Cn7mqWocHmlS89FFmUYcmaN2H7lNKKTnhRg5EtrzsFCCiuyN0Wv9y-LbGLV3-Ojv_kbD50FoScQ8BDXS5b_w6Ir1MqEdQ3qFZ3MLcvlPiIgG2BqyJX3ybYnVpIlrVrrdYD1-lkjLcjxOBNJvvUKNUAzkQ required: true description: Refresh token - name: session_name in: query schema: type: string example: forked_session_name required: true description: New session name responses: '200': $ref: '#/components/responses/PublicTokenResponse' requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 7620 method: public/fork_token params: refresh_token: 1568800656974.1CWcuzUS.MGy49NK4hpTwvR1OYWfpqMEkH4T4oDg4tNIcrM7KdeyxXRcSFqiGzA_D4Cn7mqWocHmlS89FFmUYcmaN2H7lNKKTnhRg5EtrzsFCCiuyN0Wv9y-LbGLV3-Ojv_kbD50FoScQ8BDXS5b_w6Ir1MqEdQ3qFZ3MLcvlPiIgG2BqyJX3ybYnVpIlrVrrdYD1-lkjLcjxOBNJvvUKNUAzkQ session_name: forked_session_name description: JSON-RPC Request Example description: JSON-RPC request body description: 'Generates a token for a new named session. This method can be used only with session scoped tokens. **📖 More Details:** [Fork and Exchange Tokens](https://docs.deribit.com/articles/authentication#fork-and-exchange-tokens) [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Ffork_token) ' x-mint: metadata: title: public/fork_token og:title: public/fork_token keywords: - public/fork_token - refresh_token - session_name - access_token - token_type - expires_in - scope - sid href: /api-reference/authentication/public-fork_token /public/get_block_rfq_trades: get: parameters: - name: currency required: true in: query schema: $ref: '#/components/schemas/currency_with_any' description: The currency symbol or `"any"` for all - name: continuation in: query required: false schema: type: string example: 1738050297271:103 description: Continuation token for pagination. Consists of `timestamp` and `block_rfq_id`. - name: count in: query required: false schema: type: integer maximum: 1000 minimum: 1 description: Count of Block RFQs returned, maximum - `1000` responses: '200': $ref: '#/components/responses/PublicGetBlockRfqTradesResponse' tags: - Public requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 1 method: public/get_block_rfq_trades params: currency: BTC description: JSON-RPC Request Example description: JSON-RPC request body description: 'Returns a list of recent Block RFQ trades. Can be optionally filtered by currency. This is a public method that provides market data about completed Block RFQ trades. For private Block RFQ information, use [private/get_block_rfqs](https://docs.deribit.com/api-reference/block-rfq/private-get_block_rfqs). **📖 Related Article:** [Deribit Block RFQ API walkthrough](https://docs.deribit.com/articles/block-rfq-api-walkthrough) [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_block_rfq_trades) ' x-mint: metadata: title: public/get_block_rfq_trades og:title: public/get_block_rfq_trades keywords: - public/get_block_rfq_trades - currency - continuation - count - block_rfqs - timestamp - direction - amount - mark_price - legs - combo_id - hedge - index_prices - trades - ratio - instrument_name - price - hedge_amount href: /api-reference/block-rfq/public-get_block_rfq_trades /public/get_combos: get: tags: - Public parameters: - name: currency required: true in: query schema: $ref: '#/components/schemas/currency_with_any' description: The currency symbol or `"any"` for all responses: '200': $ref: '#/components/responses/PublicGetCombosResponse' requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 2 method: public/get_combos params: currency: BTC description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves information about active combos for the specified currency. Returns detailed information including leg structures and combo properties. For a list of combo IDs only, use [public/get_combo_ids](https://docs.deribit.com/api-reference/combo-books/public-get_combo_ids). For details about a specific combo, use [public/get_combo_details](https://docs.deribit.com/api-reference/combo-books/public-get_combo_details). [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_combos) ' x-mint: metadata: title: public/get_combos og:title: public/get_combos keywords: - public/get_combos - currency - instrument_id - state - state_timestamp - creation_timestamp - legs - instrument_name - amount href: /api-reference/combo-books/public-get_combos /public/get_combo_ids: get: tags: - Public parameters: - name: currency required: true in: query schema: $ref: '#/components/schemas/currency' description: The currency symbol - name: state required: false in: query schema: $ref: '#/components/schemas/combo_state' description: Combo state, if not provided combos of all states are considered responses: '200': $ref: '#/components/responses/PublicGetComboIdsResponse' requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 1 method: public/get_combo_ids params: currency: BTC state: active description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves available combo IDs. This method can be used to get the list of all combos, or only the list of combos in the given state. Use [public/get_combo_details](https://docs.deribit.com/api-reference/combo-books/public-get_combo_details) to retrieve detailed information about a specific combo. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_combo_ids) ' x-mint: metadata: title: public/get_combo_ids og:title: public/get_combo_ids keywords: - public/get_combo_ids - currency - state href: /api-reference/combo-books/public-get_combo_ids /public/get_combo_details: get: tags: - Public parameters: - name: combo_id required: true in: query schema: $ref: '#/components/schemas/combo_id' description: Combo ID responses: '200': $ref: '#/components/responses/PublicGetComboDetailsResponse' requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 3 method: public/get_combo_details params: combo_id: BTC-FS-29APR22_PERP description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves detailed information about a specific combo, including its leg structure, state, and other properties. Use [public/get_combo_ids](https://docs.deribit.com/api-reference/combo-books/public-get_combo_ids) to get a list of available combo IDs. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_combo_details) ' x-mint: metadata: title: public/get_combo_details og:title: public/get_combo_details keywords: - public/get_combo_details - combo_id - instrument_id - state - state_timestamp - creation_timestamp - legs - instrument_name - amount href: /api-reference/combo-books/public-get_combo_details /public/get_order_book: get: parameters: - in: query name: instrument_name required: true schema: type: string example: BTC-PERPETUAL description: The instrument name for which to retrieve the order book, see [`public/get_instruments`](#public-get_instruments) to obtain instrument names. - in: query name: depth required: false schema: type: integer enum: - 1 - 5 - 10 - 20 - 50 - 100 - 1000 - 10000 example: 5 description: The number of entries to return for bids and asks, maximum - `10000`. responses: '200': $ref: '#/components/responses/PublicGetOrderBookResponse' tags: - Public requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 8772 method: public/get_order_book params: instrument_name: BTC-PERPETUAL depth: 5 description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves the order book (bids and asks) for a given instrument, along with other market values such as best bid/ask prices, last trade price, mark price, and index price. The order book depth can be controlled using the `depth` parameter, which accepts values from 1 to 10000. The response includes price levels sorted by price (bids descending, asks ascending). [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_order_book) ' x-mint: metadata: title: public/get_order_book og:title: public/get_order_book keywords: - public/get_order_book - instrument_name - depth - timestamp - state - stats - open_interest - best_bid_price - best_bid_amount - best_ask_price - best_ask_amount - index_price - min_price - max_price - mark_price - last_price - underlying_price - underlying_index - interest_rate - bid_iv - ask_iv - mark_iv - greeks - funding_8h - current_funding - delivery_price - settlement_price - bids - asks - volume - low - high - price_change - volume_usd - delta - gamma - rho - theta - vega href: /api-reference/market-data/public-get_order_book /public/get_order_book_by_instrument_id: get: parameters: - in: query name: instrument_id required: true schema: type: integer description: The instrument ID for which to retrieve the order book, see [`public/get_instruments`](#public-get_instruments) to obtain instrument IDs. - in: query name: depth required: false schema: type: integer enum: - 1 - 5 - 10 - 20 - 50 - 100 - 1000 - 10000 description: The number of entries to return for bids and asks, maximum - `10000`. responses: '200': $ref: '#/components/responses/PublicGetOrderBookResponse' tags: - Public description: 'Retrieves the order book (bids and asks) for a given instrument ID, along with other market values such as best bid/ask prices, last trade price, mark price, and index price. This method is similar to `get_order_book` but uses instrument ID instead of instrument name. The order book depth can be controlled using the `depth` parameter, which accepts values from 1 to 10000. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_order_book_by_instrument_id) ' x-mint: metadata: title: public/get_order_book_by_instrument_id og:title: public/get_order_book_by_instrument_id keywords: - public/get_order_book_by_instrument_id - instrument_id - depth - instrument_name - timestamp - state - stats - open_interest - best_bid_price - best_bid_amount - best_ask_price - best_ask_amount - index_price - min_price - max_price - mark_price - last_price - underlying_price - underlying_index - interest_rate - bid_iv - ask_iv - mark_iv - greeks - funding_8h - current_funding - delivery_price - settlement_price - bids - asks - volume - low - high - price_change - volume_usd - delta - gamma - rho - theta - vega href: /api-reference/market-data/public-get_order_book_by_instrument_id /public/get_last_settlements_by_currency: get: parameters: - name: currency required: true in: query schema: $ref: '#/components/schemas/currency' description: The currency symbol - in: query name: type required: false schema: $ref: '#/components/schemas/settlement_type' description: Settlement type - name: count required: false in: query schema: type: integer maximum: 1000 minimum: 1 description: Number of requested items, default - `20`, maximum - `1000` - name: continuation in: query required: false schema: type: string example: xY7T6cutS3t2B9YtaDkE6TS379oKnkzTvmEDUnEUP2Msa9xKWNNaT description: Continuation token for pagination - in: query name: search_start_timestamp required: false schema: $ref: '#/components/schemas/timestamp' description: The latest timestamp to return result from (milliseconds since the UNIX epoch) responses: '200': $ref: '#/components/responses/PublicSettlementResponse' tags: - Public requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 4497 method: public/get_last_settlements_by_currency params: currency: BTC type: delivery count: 2 description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves historical settlement, delivery, and bankruptcy events from all instruments within a given currency. Settlements occur when futures or options contracts expire and are settled at the delivery price. Results can be filtered by settlement type and timestamp. Use pagination parameters (`count` and `continuation`) to retrieve large settlement histories. This data is useful for analyzing historical contract settlements and understanding market events. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_last_settlements_by_currency) ' x-mint: metadata: title: public/get_last_settlements_by_currency og:title: public/get_last_settlements_by_currency keywords: - public/get_last_settlements_by_currency - currency - type - count - continuation - search_start_timestamp - settlements - funding - funded - index_price - instrument_name - mark_price - position - profit_loss - session_bankruptcy - session_profit_loss - session_tax - session_tax_rate - socialized - timestamp href: /api-reference/market-data/public-get_last_settlements_by_currency /public/get_book_summary_by_currency: get: parameters: - name: currency required: true in: query schema: $ref: '#/components/schemas/currency' description: The currency symbol - name: kind required: false in: query schema: $ref: '#/components/schemas/kind' description: Instrument kind, if not provided instruments of all kinds are considered responses: '200': $ref: '#/components/responses/PublicGetBookSummaryResponse' tags: - Public requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 9344 method: public/get_book_summary_by_currency params: currency: BTC kind: future description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves summary information such as open interest, 24-hour volume, best bid/ask prices, last trade price, and other market statistics for all instruments in a given currency. Results can be filtered by instrument kind (future, option, etc.). This method provides a quick overview of market activity across all instruments for a currency. **Note:** For real-time updates, we recommend using the WebSocket subscription to `ticker.{instrument_name}.{interval}` instead of polling this endpoint. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_book_summary_by_currency) ' x-mint: metadata: title: public/get_book_summary_by_currency og:title: public/get_book_summary_by_currency keywords: - public/get_book_summary_by_currency - currency - kind - instrument_name - high - low - base_currency - quote_currency - volume - bid_price - ask_price - mid_price - mark_price - last - open_interest - creation_timestamp - estimated_delivery_price - volume_usd - volume_notional - current_funding - funding_8h - mark_iv - interest_rate - underlying_index - underlying_price - price_change href: /api-reference/market-data/public-get_book_summary_by_currency /public/get_book_summary_by_instrument: get: parameters: - name: instrument_name required: true in: query schema: $ref: '#/components/schemas/instrument_name' description: Instrument name responses: '200': $ref: '#/components/responses/PublicGetBookSummaryResponse' tags: - Public requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 3659 method: public/get_book_summary_by_instrument params: instrument_name: ETH-22FEB19-140-P description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves summary information such as open interest, 24-hour volume, best bid/ask prices, last trade price, mark price, and other market statistics for a specific instrument. This method provides a quick overview of current market activity and liquidity for a single instrument. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_book_summary_by_instrument) ' x-mint: metadata: title: public/get_book_summary_by_instrument og:title: public/get_book_summary_by_instrument keywords: - public/get_book_summary_by_instrument - instrument_name - high - low - base_currency - quote_currency - volume - bid_price - ask_price - mid_price - mark_price - last - open_interest - creation_timestamp - estimated_delivery_price - volume_usd - volume_notional - current_funding - funding_8h - mark_iv - interest_rate - underlying_index - underlying_price - price_change href: /api-reference/market-data/public-get_book_summary_by_instrument /public/get_last_settlements_by_instrument: get: parameters: - name: instrument_name required: true in: query schema: $ref: '#/components/schemas/instrument_name' description: Instrument name - in: query name: type required: false schema: $ref: '#/components/schemas/settlement_type' description: Settlement type - name: count required: false in: query schema: type: integer maximum: 1000 minimum: 1 description: Number of requested items, default - `20`, maximum - `1000` - name: continuation in: query required: false schema: type: string example: xY7T6cutS3t2B9YtaDkE6TS379oKnkzTvmEDUnEUP2Msa9xKWNNaT description: Continuation token for pagination - in: query name: search_start_timestamp required: false schema: $ref: '#/components/schemas/timestamp' description: The latest timestamp to return result from (milliseconds since the UNIX epoch) responses: '200': $ref: '#/components/responses/PublicSettlementResponse' tags: - Public requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 5482 method: public/get_last_settlements_by_instrument params: instrument_name: BTC-22FEB19 type: settlement count: 1 description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves historical settlement, delivery, and bankruptcy events for a specific instrument. Settlements occur when futures or options contracts expire and are settled at the delivery price. Results can be filtered by settlement type and timestamp. Use pagination parameters (`count` and `continuation`) to retrieve large settlement histories. This method is useful for tracking settlement history for a specific instrument. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_last_settlements_by_instrument) ' x-mint: metadata: title: public/get_last_settlements_by_instrument og:title: public/get_last_settlements_by_instrument keywords: - public/get_last_settlements_by_instrument - instrument_name - type - count - continuation - search_start_timestamp - settlements - funding - funded - index_price - mark_price - position - profit_loss - session_bankruptcy - session_profit_loss - session_tax - session_tax_rate - socialized - timestamp href: /api-reference/market-data/public-get_last_settlements_by_instrument /public/get_contract_size: get: tags: - Public parameters: - name: instrument_name required: true in: query schema: $ref: '#/components/schemas/instrument_name' description: Instrument name responses: '200': $ref: '#/components/responses/PublicGetContractSizeResponse' description: 'Retrieves the contract size (also known as contract multiplier) for a given instrument. The contract size determines how many units of the underlying asset one contract represents. This value is essential for calculating position values, margin requirements, and P&L calculations. Different instruments may have different contract sizes. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_contract_size) ' x-mint: metadata: title: public/get_contract_size og:title: public/get_contract_size keywords: - public/get_contract_size - instrument_name - contract_size href: /api-reference/market-data/public-get_contract_size /public/get_trade_volumes: get: parameters: - name: extended in: query required: false schema: type: boolean description: Request for extended statistics. Including also 7 and 30 days volumes (default false) responses: '200': $ref: '#/components/responses/PublicGetTradesVolumesResponse' tags: - Public description: 'Retrieves aggregated 24-hour trade volumes for different instrument types and currencies. The volume statistics include all executed trades across the platform. **Note:** Position moves are not included in this volume. Block trades and Block RFQ trades are included in the volume calculations. Use the `extended` parameter to include additional volume statistics and breakdowns. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_trade_volumes) ' x-mint: metadata: title: public/get_trade_volumes og:title: public/get_trade_volumes keywords: - public/get_trade_volumes - extended - currency - calls_volume - puts_volume - futures_volume - spot_volume - calls_volume_7d - puts_volume_7d - futures_volume_7d - spot_volume_7d - calls_volume_30d - puts_volume_30d - futures_volume_30d - spot_volume_30d href: /api-reference/market-data/public-get_trade_volumes /public/get_index_price: get: parameters: - name: index_name required: true in: query schema: $ref: '#/components/schemas/index_name' description: Index identifier, matches (base) cryptocurrency with quote currency responses: '200': $ref: '#/components/responses/PublicGetIndexPriceResponse' tags: - Public description: 'Retrieves the current index price value for a given index name. Index prices are used as reference prices for mark price calculations and settlement. Use `get_index_price_names` or `get_supported_index_names` to retrieve available index names. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_index_price) ' x-mint: metadata: title: public/get_index_price og:title: public/get_index_price keywords: - public/get_index_price - index_name - index_price - estimated_delivery_price href: /api-reference/market-data/public-get_index_price /public/get_index_price_names: get: tags: - Public parameters: - name: extended in: query required: false schema: type: boolean default: false example: true description: When set to `true`, returns additional information including `future_combo_creation_enabled` and `option_combo_creation_enabled` for each index responses: '200': $ref: '#/components/responses/PublicGetIndexPriceNamesResponse' requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 1 method: public/get_index_price_names params: extended: true description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves the identifiers (names) of all supported price indexes. Price indexes are reference prices used for mark price calculations, settlement, and other market operations. When the `extended` parameter is set to `true`, the response includes additional information such as whether future combo creation and option combo creation are enabled for each index. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_index_price_names) ' x-mint: metadata: title: public/get_index_price_names og:title: public/get_index_price_names keywords: - public/get_index_price_names - extended - name - future_combo_creation_enabled - option_combo_creation_enabled href: /api-reference/market-data/public-get_index_price_names /public/get_supported_index_names: get: parameters: - name: type required: false in: query schema: type: string enum: - all - spot - derivative description: Type of a cryptocurrency price index responses: '200': $ref: '#/components/responses/PublicGetIndexPriceNamesResponse' tags: - Public description: 'Retrieves the identifiers (names) of all supported price indexes, optionally filtered by index type. Price indexes are reference prices used for mark price calculations, settlement, and other market operations. Use the `type` parameter to filter indexes by type (e.g., spot, futures, etc.). This method helps discover available indexes for use with other API methods. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_supported_index_names) ' x-mint: metadata: title: public/get_supported_index_names og:title: public/get_supported_index_names keywords: - public/get_supported_index_names - type - name - future_combo_creation_enabled - option_combo_creation_enabled href: /api-reference/market-data/public-get_supported_index_names /public/get_instruments: get: tags: - Public parameters: - name: currency required: true in: query schema: $ref: '#/components/schemas/currency_with_any' description: The currency symbol or `"any"` for all - name: kind required: false in: query schema: $ref: '#/components/schemas/kind' description: Instrument kind, if not provided instruments of all kinds are considered - name: expired in: query schema: type: boolean default: false description: Set to true to show recently expired instruments instead of active ones. required: false responses: '200': $ref: '#/components/responses/PublicGetInstrumentsResponse' requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 1 method: public/get_instruments params: currency: BTC kind: future description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves available trading instruments. This method can be used to see which instruments are available for trading, or which instruments have recently expired. **Note - This method has distinct API rate limiting requirements:** Sustained rate: 1 request/second. To avoid rate limits, we recommend using either the REST requests for server-cached data or the WebSocket subscription to [instrument_state.{kind}.{currency}](https://docs.deribit.com/api-reference/subscription-channels/instrument-state-kind-currency) for real-time updates. For more information, see [Rate Limits](https://support.deribit.com/hc/en-us/articles/25944617523357-Rate-Limits). Results can be filtered by currency and instrument kind (future, option, etc.). Set the `expired` parameter to `true` to retrieve recently expired instruments instead of active ones. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_instruments) ' x-mint: metadata: title: public/get_instruments og:title: public/get_instruments keywords: - public/get_instruments - currency - kind - expired - settlement_currency - counter_currency - base_currency - quote_currency - min_trade_amount - instrument_name - instrument_id - is_active - settlement_period - creation_timestamp - tick_size - tick_size_steps - expiration_timestamp - strike - option_type - future_type - instrument_type - contract_size - maker_commission - taker_commission - max_liquidation_commission - block_trade_commission - block_trade_tick_size - block_trade_min_trade_amount - max_leverage - price_index - state - above_price href: /api-reference/market-data/public-get_instruments /public/get_instrument: get: tags: - Public parameters: - name: instrument_name required: true in: query schema: $ref: '#/components/schemas/instrument_name' description: Instrument name responses: '200': $ref: '#/components/responses/PublicGetInstrumentResponse' requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 2 method: public/get_instrument params: instrument_name: BTC-13JAN23-16000-P description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves detailed information about a specific instrument, including instrument specifications, contract details, tick size, settlement currency, expiration date (for futures and options), strike price (for options), and other instrument parameters. This method is useful for obtaining instrument metadata needed for trading operations and calculations. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_instrument) ' x-mint: metadata: title: public/get_instrument og:title: public/get_instrument keywords: - public/get_instrument - instrument_name - kind - settlement_currency - counter_currency - base_currency - quote_currency - min_trade_amount - instrument_id - is_active - settlement_period - creation_timestamp - tick_size - tick_size_steps - expiration_timestamp - strike - option_type - future_type - instrument_type - contract_size - maker_commission - taker_commission - max_liquidation_commission - block_trade_commission - block_trade_tick_size - block_trade_min_trade_amount - max_leverage - price_index - state - above_price href: /api-reference/market-data/public-get_instrument /public/get_historical_volatility: get: parameters: - name: currency required: true in: query schema: $ref: '#/components/schemas/currency' description: The currency symbol tags: - Public responses: '200': $ref: '#/components/responses/PublicGetHistoricalVolatilityResponse' requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 8387 method: public/get_historical_volatility params: currency: BTC description: JSON-RPC Request Example description: JSON-RPC request body description: 'Provides historical volatility data for a given cryptocurrency. Historical volatility measures the degree of price variation over a past period and is useful for risk assessment and option pricing. The response includes volatility statistics calculated from historical price movements. This data can be used for portfolio risk analysis and understanding market conditions. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_historical_volatility) ' x-mint: metadata: title: public/get_historical_volatility og:title: public/get_historical_volatility keywords: - public/get_historical_volatility - currency - timestamp - value href: /api-reference/market-data/public-get_historical_volatility /public/get_funding_rate_history: get: tags: - Public parameters: - name: instrument_name required: true in: query schema: $ref: '#/components/schemas/instrument_name' description: Instrument name - name: start_timestamp required: true in: query schema: $ref: '#/components/schemas/timestamp' description: The earliest timestamp to return result from (milliseconds since the UNIX epoch) - name: end_timestamp required: true in: query schema: $ref: '#/components/schemas/timestamp' description: The most recent timestamp to return result from (milliseconds since the UNIX epoch) responses: '200': $ref: '#/components/responses/PublicGetFundingRateHistoryResponse' requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 7617 method: public/get_funding_rate_history params: instrument_name: BTC-PERPETUAL start_timestamp: 1569888000000 end_timestamp: 1569902400000 description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves hourly historical funding rate (interest rate) data for a PERPETUAL instrument over a specified time period. Funding rates are periodic payments exchanged between long and short positions in perpetual contracts. The response includes hourly funding rate values, which can be used to analyze funding rate trends and calculate historical funding costs. This method is applicable only for PERPETUAL instruments. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_funding_rate_history) ' x-mint: metadata: title: public/get_funding_rate_history og:title: public/get_funding_rate_history keywords: - public/get_funding_rate_history - instrument_name - start_timestamp - end_timestamp - timestamp - prev_index_price - index_price - interest_1h - interest_8h href: /api-reference/market-data/public-get_funding_rate_history /public/get_funding_rate_value: get: tags: - Public parameters: - name: instrument_name required: true in: query schema: $ref: '#/components/schemas/instrument_name' description: Instrument name - name: start_timestamp required: true in: query schema: $ref: '#/components/schemas/timestamp' description: The earliest timestamp to return result from (milliseconds since the UNIX epoch) - name: end_timestamp required: true in: query schema: $ref: '#/components/schemas/timestamp' description: The most recent timestamp to return result from (milliseconds since the UNIX epoch) responses: '200': $ref: '#/components/responses/PublicGetFundingRateValueResponse' requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 7617 method: public/get_funding_rate_value params: instrument_name: BTC-PERPETUAL start_timestamp: 1569888000000 end_timestamp: 1569974400000 description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves the funding rate (interest rate) value for a perpetual instrument over a specified time period. Funding rates are periodic payments exchanged between long and short positions in perpetual contracts. This method is applicable only for PERPETUAL instruments. The funding rate is typically expressed as a percentage and is used to keep the perpetual contract price aligned with the underlying index price. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_funding_rate_value) ' x-mint: metadata: title: public/get_funding_rate_value og:title: public/get_funding_rate_value keywords: - public/get_funding_rate_value - instrument_name - start_timestamp - end_timestamp href: /api-reference/market-data/public-get_funding_rate_value /public/get_index_chart_data: get: parameters: - name: index_name required: true in: query schema: $ref: '#/components/schemas/index_name' description: Index identifier, matches (base) cryptocurrency with quote currency - name: range in: query required: true schema: type: string enum: - 1h - 1d - 2d - 1m - 1y - all description: Range of the data to return responses: '200': $ref: '#/components/responses/PublicGetIndexChartDataResponse' tags: - Public requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 1 method: public/get_index_chart_data params: index_name: btc_usd range: 1m description: JSON-RPC Request Example description: JSON-RPC request body description: 'Returns historical price index chart data for the specified index name and time range. The data is formatted for use in charting applications and shows price index values over time. Use the `range` parameter to specify the time period for which to retrieve chart data. This method is useful for visualizing price index trends and historical movements. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_index_chart_data) ' x-mint: metadata: title: public/get_index_chart_data og:title: public/get_index_chart_data keywords: - public/get_index_chart_data - index_name - range href: /api-reference/market-data/public-get_index_chart_data /public/get_mark_price_history: get: parameters: - name: instrument_name required: true in: query schema: $ref: '#/components/schemas/instrument_name' description: Instrument name - name: start_timestamp required: true in: query schema: $ref: '#/components/schemas/timestamp' description: The earliest timestamp to return result from (milliseconds since the UNIX epoch) - name: end_timestamp required: true in: query schema: $ref: '#/components/schemas/timestamp' description: The most recent timestamp to return result from (milliseconds since the UNIX epoch) responses: '200': $ref: '#/components/responses/PublicGetMarkPriceHistoryResponse' tags: - Public requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 1 method: public/get_mark_price_history params: instrument_name: BTC-25JUN21-50000-C start_timestamp: 1609376800000 end_timestamp: 1609376810000 description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves 5-minute historical mark price data for an instrument. Mark prices are used for margin calculations and position valuations. **Note:** Currently, mark price history is available only for a subset of options that participate in volatility index calculations. All other instruments, including futures and perpetuals, will return an empty list. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_mark_price_history) ' x-mint: metadata: title: public/get_mark_price_history og:title: public/get_mark_price_history keywords: - public/get_mark_price_history - instrument_name - start_timestamp - end_timestamp href: /api-reference/market-data/public-get_mark_price_history /public/get_expirations: get: tags: - Public parameters: - name: currency required: true in: query schema: $ref: '#/components/schemas/settlement_currency_with_any_and_grouped' description: The currency symbol or `"any"` for all or '"grouped"' for all grouped by currency - name: kind required: true in: query schema: $ref: '#/components/schemas/kind_future_or_option_with_any' description: Instrument kind, `"future"` or `"option"` or `"any"` - name: currency_pair required: false in: query schema: $ref: '#/components/schemas/index_name' description: The currency pair symbol responses: '200': $ref: '#/components/responses/PublicGetExpirationsResponse' requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 1 method: public/get_expirations params: currency: any kind: any description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves all available expiration timestamps for instruments. This method can be used to discover which expiration dates are available for trading, which is useful for finding instruments with specific expiration dates. Results can be filtered by settlement currency, instrument kind (future or option), and currency pair. The response includes expiration timestamps in milliseconds since the UNIX epoch. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_expirations) ' x-mint: metadata: title: public/get_expirations og:title: public/get_expirations keywords: - public/get_expirations - currency - kind - currency_pair href: /api-reference/market-data/public-get_expirations /public/get_apr_history: get: tags: - Public parameters: - name: currency in: query required: true schema: type: string enum: - usde - steth - usdc - build example: steth description: Currency for which to retrieve APR history - name: limit in: query required: false schema: type: integer example: 5 description: Number of days to retrieve (default `365`, maximum `365`) - name: before in: query required: false schema: type: integer description: Used to receive APR history before given epoch day responses: '200': $ref: '#/components/responses/PublicGetAprHistoryResponse' requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 1 method: public/get_apr_history params: currency: steth limit: 5 description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves historical Annual Percentage Rate (APR) data for yield-generating tokens. APR represents the annualized return rate for holding these tokens on Deribit. This method is only applicable to yield-generating tokens: `USDE`, `STETH`, `USDC`, and `BUILD`. Use the `limit` parameter to specify the number of days to retrieve (default 365, maximum 365), and `before` to retrieve APR history before a specific epoch day. **📖 Related Support Article:** [Yield reward-bearing coins](https://support.deribit.com/hc/en-us/articles/31424939199261-Yield-reward-bearing-coins) [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_apr_history) ' x-mint: metadata: title: public/get_apr_history og:title: public/get_apr_history keywords: - public/get_apr_history - currency - limit - before - continuation - data - day - apr href: /api-reference/market-data/public-get_apr_history /public/get_last_trades_by_instrument: get: parameters: - name: instrument_name required: true in: query schema: $ref: '#/components/schemas/instrument_name' description: Instrument name - name: start_seq required: false in: query schema: type: integer description: The sequence number of the first trade to be returned - name: end_seq required: false in: query schema: type: integer description: The sequence number of the last trade to be returned - name: start_timestamp required: false in: query schema: $ref: '#/components/schemas/timestamp' description: The earliest timestamp to return result from (milliseconds since the UNIX epoch). When param is provided trades are returned from the earliest - name: end_timestamp required: false in: query schema: $ref: '#/components/schemas/timestamp' description: 'The most recent timestamp to return result from (milliseconds since the UNIX epoch). Only one of params: start_timestamp, end_timestamp is truly required' - name: count required: false in: query schema: type: integer maximum: 1000 minimum: 1 description: Number of requested items, default - `10`, maximum - `1000` - name: sorting required: false in: query schema: $ref: '#/components/schemas/sorting' description: Direction of results sorting (`default` value means no sorting, results will be returned in order in which they left the database) responses: '200': $ref: '#/components/responses/PublicTradesHistoryResponse' tags: - Public requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 9267 method: public/get_last_trades_by_instrument params: instrument_name: BTC-PERPETUAL count: 1 description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves the latest trades that have occurred for a specific instrument. Returns trade details including price, amount, direction, timestamp, and trade ID. Results can be filtered by sequence number range or timestamp range. Use the `count` parameter to limit the number of trades returned, and `sorting` to control the order (ascending or descending by trade ID). [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_last_trades_by_instrument) ' x-mint: metadata: title: public/get_last_trades_by_instrument og:title: public/get_last_trades_by_instrument keywords: - public/get_last_trades_by_instrument - instrument_name - start_seq - end_seq - start_timestamp - end_timestamp - count - sorting - trades - has_more - trade_id - trade_seq - timestamp - direction - tick_direction - index_price - price - amount - contracts - iv - liquidation - mark_price - block_trade_id - block_trade_leg_count - combo_id - combo_trade_id - block_rfq_id href: /api-reference/market-data/public-get_last_trades_by_instrument /public/get_last_trades_by_instrument_and_time: get: parameters: - name: instrument_name required: true in: query schema: $ref: '#/components/schemas/instrument_name' description: Instrument name - name: start_timestamp required: true in: query schema: $ref: '#/components/schemas/timestamp' description: The earliest timestamp to return result from (milliseconds since the UNIX epoch). When param is provided trades are returned from the earliest - name: end_timestamp required: true in: query schema: $ref: '#/components/schemas/timestamp' description: 'The most recent timestamp to return result from (milliseconds since the UNIX epoch). Only one of params: start_timestamp, end_timestamp is truly required' - name: count required: false in: query schema: type: integer maximum: 1000 minimum: 1 description: Number of requested items, default - `10`, maximum - `1000` - name: sorting required: false in: query schema: $ref: '#/components/schemas/sorting' description: Direction of results sorting (`default` value means no sorting, results will be returned in order in which they left the database) responses: '200': $ref: '#/components/responses/PublicTradesHistoryResponse' tags: - Public requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 3983 method: public/get_last_trades_by_instrument_and_time params: instrument_name: ETH-PERPETUAL end_timestamp: 1590480022768 count: 1 description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves the latest trades that have occurred for a specific instrument within a specified time range. Returns trade details including price, amount, direction, timestamp, and trade ID. Use the `count` parameter to limit the number of trades returned, and `sorting` to control the order (ascending or descending by trade ID). This method is useful for analyzing trading activity over specific time periods. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_last_trades_by_instrument_and_time) ' x-mint: metadata: title: public/get_last_trades_by_instrument_and_time og:title: public/get_last_trades_by_instrument_and_time keywords: - public/get_last_trades_by_instrument_and_time - instrument_name - start_timestamp - end_timestamp - count - sorting - trades - has_more - trade_id - trade_seq - timestamp - direction - tick_direction - index_price - price - amount - contracts - iv - liquidation - mark_price - block_trade_id - block_trade_leg_count - combo_id - combo_trade_id - block_rfq_id href: /api-reference/market-data/public-get_last_trades_by_instrument_and_time /public/get_last_trades_by_currency: get: parameters: - name: currency required: true in: query schema: $ref: '#/components/schemas/currency' description: The currency symbol - name: kind required: false in: query schema: $ref: '#/components/schemas/kind_with_combo_all' description: Instrument kind, `"combo"` for any combo or `"any"` for all. If not provided instruments of all kinds are considered - name: start_id required: false in: query schema: $ref: '#/components/schemas/trade_id' description: 'The ID of the first trade to be returned. Number for BTC trades, or hyphen name in ex. `"ETH-15"` # `"ETH_USDC-16"`' - name: end_id required: false in: query schema: $ref: '#/components/schemas/trade_id' description: 'The ID of the last trade to be returned. Number for BTC trades, or hyphen name in ex. `"ETH-15"` # `"ETH_USDC-16"`' - name: start_timestamp required: false in: query schema: $ref: '#/components/schemas/timestamp' description: The earliest timestamp to return result from (milliseconds since the UNIX epoch). When param is provided trades are returned from the earliest - name: end_timestamp required: false in: query schema: $ref: '#/components/schemas/timestamp' description: 'The most recent timestamp to return result from (milliseconds since the UNIX epoch). Only one of params: start_timestamp, end_timestamp is truly required' - name: count required: false in: query schema: type: integer maximum: 1000 minimum: 1 description: Number of requested items, default - `10`, maximum - `1000` - name: sorting required: false in: query schema: $ref: '#/components/schemas/sorting' description: Direction of results sorting (`default` value means no sorting, results will be returned in order in which they left the database) responses: '200': $ref: '#/components/responses/PublicTradesHistoryResponse' tags: - Public requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 9290 method: public/get_last_trades_by_currency params: currency: BTC count: 3 description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves the latest trades that have occurred for instruments in a specific currency. Returns trade details including price, amount, direction, timestamp, and trade ID for all instruments in the currency. Results can be filtered by instrument kind and trade ID range or timestamp range. Use the `count` parameter to limit the number of trades returned, and `sorting` to control the order (ascending or descending by trade ID). [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_last_trades_by_currency) ' x-mint: metadata: title: public/get_last_trades_by_currency og:title: public/get_last_trades_by_currency keywords: - public/get_last_trades_by_currency - currency - kind - start_id - end_id - start_timestamp - end_timestamp - count - sorting - trades - has_more - trade_id - trade_seq - instrument_name - timestamp - direction - tick_direction - index_price - price - amount - contracts - iv - liquidation - mark_price - block_trade_id - block_trade_leg_count - combo_id - combo_trade_id - block_rfq_id href: /api-reference/market-data/public-get_last_trades_by_currency /public/get_last_trades_by_currency_and_time: get: parameters: - name: currency required: true in: query schema: $ref: '#/components/schemas/currency' description: The currency symbol - name: kind required: false in: query schema: $ref: '#/components/schemas/kind_with_combo_all' description: Instrument kind, `"combo"` for any combo or `"any"` for all. If not provided instruments of all kinds are considered - name: start_timestamp required: true in: query schema: $ref: '#/components/schemas/timestamp' description: The earliest timestamp to return result from (milliseconds since the UNIX epoch). When param is provided trades are returned from the earliest - name: end_timestamp required: true in: query schema: $ref: '#/components/schemas/timestamp' description: 'The most recent timestamp to return result from (milliseconds since the UNIX epoch). Only one of params: start_timestamp, end_timestamp is truly required' - name: count required: false in: query schema: type: integer maximum: 1000 minimum: 1 description: Number of requested items, default - `10`, maximum - `1000` - name: sorting required: false in: query schema: $ref: '#/components/schemas/sorting' description: Direction of results sorting (`default` value means no sorting, results will be returned in order in which they left the database) responses: '200': $ref: '#/components/responses/PublicTradesHistoryResponse' tags: - Public requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 1469 method: public/get_last_trades_by_currency_and_time params: currency: BTC start_timestamp: 1590470022768 end_timestamp: 1590480022768 count: 1 description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves the latest trades that have occurred for instruments in a specific currency within a specified time range. Returns trade details including price, amount, direction, timestamp, and trade ID. Results can be filtered by instrument kind. Use the `count` parameter to limit the number of trades returned, and `sorting` to control the order (ascending or descending by trade ID). > **Note:** This endpoint only returns trades from the last **24 hours**. Requests with `start_timestamp` older than 24 hours will return an empty result without an error. **Scope:** `trade:read` [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_last_trades_by_currency_and_time) ' x-mint: metadata: title: public/get_last_trades_by_currency_and_time og:title: public/get_last_trades_by_currency_and_time keywords: - public/get_last_trades_by_currency_and_time - currency - kind - start_timestamp - end_timestamp - count - sorting - trades - has_more - trade_id - trade_seq - instrument_name - timestamp - direction - tick_direction - index_price - price - amount - contracts - iv - liquidation - mark_price - block_trade_id - block_trade_leg_count - combo_id - combo_trade_id - block_rfq_id href: /api-reference/market-data/public-get_last_trades_by_currency_and_time /public/get_currencies: get: tags: - Public responses: '200': $ref: '#/components/responses/PublicGetCurrenciesResponse' requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 7538 method: public/get_currencies params: {} description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves all cryptocurrencies supported by the Deribit API. Returns a list of available currencies with their codes and basic information. This method takes no parameters and is useful for discovering which currencies are available for trading on the platform. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_currencies) ' x-mint: metadata: title: public/get_currencies og:title: public/get_currencies keywords: - public/get_currencies - withdrawal_fee - withdrawal_priorities - min_withdrawal_fee - currency - currency_long - min_confirmations - coin_type - in_cross_collateral_pool - apr - network_fee - network_currency - decimals - name - value href: /api-reference/market-data/public-get_currencies /public/get_funding_chart_data: get: parameters: - name: instrument_name required: true in: query schema: $ref: '#/components/schemas/instrument_name' description: Instrument name - name: length in: query schema: type: string enum: - 8h - 24h - 1m required: true description: Specifies time period. `8h` - 8 hours, `24h` - 24 hours, `1m` - 1 month responses: '200': $ref: '#/components/responses/PublicGetFundingChartDataResponse' tags: - Public description: 'Retrieves funding rate chart data points for a PERPETUAL instrument within a given time period. The data is formatted for use in charting applications and includes funding rate values at regular intervals. Use the `length` parameter to specify the time period for which to retrieve chart data. This method is useful for visualizing funding rate trends over time. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_funding_chart_data) ' x-mint: metadata: title: public/get_funding_chart_data og:title: public/get_funding_chart_data keywords: - public/get_funding_chart_data - instrument_name - length - current_interest - interest_8h - data - timestamp - index_price href: /api-reference/market-data/public-get_funding_chart_data /public/get_tradingview_chart_data: get: parameters: - name: instrument_name required: true in: query schema: $ref: '#/components/schemas/instrument_name' description: Instrument name - name: start_timestamp required: true in: query schema: $ref: '#/components/schemas/timestamp' description: The earliest timestamp to return result from (milliseconds since the UNIX epoch) - name: end_timestamp required: true in: query schema: $ref: '#/components/schemas/timestamp' description: The most recent timestamp to return result from (milliseconds since the UNIX epoch) - name: resolution in: query schema: type: string enum: - 1 - 3 - 5 - 10 - 15 - 30 - 60 - 120 - 180 - 360 - 720 - 1D required: true description: Chart bars resolution given in full minutes or keyword `1D` (only some specific resolutions are supported) responses: '200': $ref: '#/components/responses/PublicGetTradingviewChartDataResponse' tags: - Public requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 833 method: public/get_tradingview_chart_data params: instrument_name: BTC-5APR19 start_timestamp: 1554373800000 end_timestamp: 1554376800000 resolution: '30' description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves publicly available market data formatted for generating TradingView-compatible candle charts. The data includes open, high, low, close (OHLC) prices and volume for specified time intervals. Use the `chart_resolution` parameter to specify the candle interval (e.g., 1m, 5m, 1h, 1d). This method provides the standard format used by TradingView and other charting platforms. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_tradingview_chart_data) ' x-mint: metadata: title: public/get_tradingview_chart_data og:title: public/get_tradingview_chart_data keywords: - public/get_tradingview_chart_data - instrument_name - start_timestamp - end_timestamp - resolution - status - ticks - volume - cost - open - close - high - low href: /api-reference/market-data/public-get_tradingview_chart_data /public/get_volatility_index_data: get: parameters: - name: currency required: true in: query schema: $ref: '#/components/schemas/currency' description: The currency symbol - name: start_timestamp required: true in: query schema: $ref: '#/components/schemas/timestamp' description: The earliest timestamp to return result from (milliseconds since the UNIX epoch) - name: end_timestamp required: true in: query schema: $ref: '#/components/schemas/timestamp' description: The most recent timestamp to return result from (milliseconds since the UNIX epoch) - name: resolution in: query schema: type: string enum: - 1 - 60 - 3600 - 43200 - 1D required: true description: Time resolution given in full seconds or keyword `1D` (only some specific resolutions are supported) responses: '200': $ref: '#/components/responses/PublicGetVolatilityIndexDataResponse' tags: - Public requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 833 method: public/get_volatility_index_data params: currency: BTC start_timestamp: 1599373800000 end_timestamp: 1599376800000 resolution: '60' description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves volatility index (VIX) chart data formatted as candles. Volatility indexes measure market expectations of future volatility and are useful for risk assessment and trading strategies. Use the `vix_resolution` parameter to specify the candle interval. The data shows historical volatility index values over time and is formatted for use in charting applications. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_volatility_index_data) ' x-mint: metadata: title: public/get_volatility_index_data og:title: public/get_volatility_index_data keywords: - public/get_volatility_index_data - currency - start_timestamp - end_timestamp - resolution - data - continuation href: /api-reference/market-data/public-get_volatility_index_data /public/ticker: get: tags: - Public parameters: - name: instrument_name required: true in: query schema: $ref: '#/components/schemas/instrument_name' description: Instrument name responses: '200': $ref: '#/components/responses/PublicTickerResponse' requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 8106 method: public/ticker params: instrument_name: BTC-PERPETUAL description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves the ticker (24-hour statistics) for a specific instrument. The ticker includes the last trade price, best bid/ask prices, 24-hour high/low, 24-hour volume, open interest, mark price, and other market statistics. This is a lightweight method for getting current market data for a single instrument. For real-time updates, consider using WebSocket subscriptions to ticker channels. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fticker) ' x-mint: metadata: title: public/ticker og:title: public/ticker keywords: - public/ticker - instrument_name - timestamp - state - stats - open_interest - best_bid_price - best_bid_amount - best_ask_price - best_ask_amount - index_price - min_price - max_price - mark_price - last_price - underlying_price - underlying_index - interest_rate - bid_iv - ask_iv - mark_iv - greeks - funding_8h - current_funding - interest_value - delivery_price - settlement_price - estimated_delivery_price - volume - low - high - price_change - volume_usd - delta - gamma - rho - theta - vega href: /api-reference/market-data/public-ticker /public/set_heartbeat: get: parameters: - in: query name: interval required: true schema: example: 30 type: number description: The heartbeat interval in seconds, but not less than 10 responses: '200': $ref: '#/components/responses/OkResponse' tags: - Public requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 9098 method: public/set_heartbeat params: interval: 30 description: JSON-RPC Request Example description: JSON-RPC request body description: 'Signals the WebSocket connection to send and request heartbeats. Heartbeats can be used to detect stale connections. When heartbeats have been set up, the API server will send `heartbeat` messages and `test_request` messages. Your software should respond to `test_request` messages by sending a `/api/v2/public/test` request. If your software fails to do so, the API server will immediately close the connection. If your account is configured to cancel on disconnect, any orders opened over the connection will be cancelled. **WebSocket Only:** This method is designed exclusively for WebSocket connections. Attempting to use it via REST/HTTP will result in an error response. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fset_heartbeat) ' x-mint: metadata: title: public/set_heartbeat og:title: public/set_heartbeat keywords: - public/set_heartbeat - interval href: /api-reference/session-management/public-set_heartbeat /public/disable_heartbeat: get: tags: - Public responses: '200': $ref: '#/components/responses/OkResponse' requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 3562 method: public/disable_heartbeat params: {} description: JSON-RPC Request Example description: JSON-RPC request body description: 'Stop sending heartbeat messages. This method takes no parameters. **WebSocket Only:** This method is designed exclusively for WebSocket connections. Attempting to use it via REST/HTTP will result in an error response. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fdisable_heartbeat) ' x-mint: metadata: title: public/disable_heartbeat og:title: public/disable_heartbeat keywords: - public/disable_heartbeat href: /api-reference/session-management/public-disable_heartbeat /public/subscribe: get: tags: - Public parameters: - name: channels in: query schema: type: array items: type: string example: deribit_price_index.btc_usd example: - deribit_price_index.btc_usd required: true description: A list of channels to subscribe to. See [Notifications and Subscriptions](https://docs.deribit.com/articles/notifications) for all available channels. style: form explode: true responses: '200': $ref: '#/components/responses/PrivateSubscribeResponse' '401': $ref: '#/components/responses/ErrorMessageResponse' requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 3600 method: public/subscribe params: channels: - deribit_price_index.btc_usd description: JSON-RPC Request Example description: JSON-RPC request body description: 'Subscribe to one or more channels. This is the same method as `/private/subscribe`, but it can only be used for ''public'' channels. For a complete list of available subscription channels and their notification formats, see [Notifications and Subscriptions](https://docs.deribit.com/articles/notifications). **Note - This method has distinct API rate limiting requirements:** Sustained rate: ~3.3 requests/second. For more information, see [Rate Limits](https://docs.deribit.com/articles/rate-limits). **📖 Related Article:** [Market Data Collection Best Practices](https://docs.deribit.com/articles/market-data-collection-best-practices) [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fsubscribe) ' x-mint: metadata: title: public/subscribe og:title: public/subscribe keywords: - public/subscribe - channels href: /api-reference/subscription-management/public-subscribe /public/unsubscribe: get: tags: - Public parameters: - name: channels in: query schema: type: array items: type: string example: deribit_price_index.btc_usd example: - deribit_price_index.btc_usd required: true description: A list of channels to unsubscribe from. Only successfully unsubscribed channels will be returned in the result. See [Notifications and Subscriptions](https://docs.deribit.com/articles/notifications) for all available channels. style: form explode: true responses: '200': $ref: '#/components/responses/Getunsubscribe200response' '401': $ref: '#/components/responses/ErrorMessageResponse' requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 8691 method: public/unsubscribe params: channels: - deribit_price_index.btc_usd description: JSON-RPC Request Example description: JSON-RPC request body description: 'Unsubscribe from one or more channels. The response contains only the channels that were successfully unsubscribed in this request. For a complete list of available subscription channels and their notification formats, see [Notifications and Subscriptions](https://docs.deribit.com/articles/notifications). **Note:** The `result` field in the response contains only the channels that were successfully processed and unsubscribed from this specific request. It does not include all previously subscribed topics. If a channel in the request is invalid, not subscribed, or fails validation, it will not appear in the result. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Funsubscribe) ' x-mint: metadata: title: public/unsubscribe og:title: public/unsubscribe keywords: - public/unsubscribe - channels href: /api-reference/subscription-management/public-unsubscribe /public/unsubscribe_all: get: tags: - Public responses: '200': $ref: '#/components/responses/OkResponse' requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 153 method: public/unsubscribe_all params: {} description: JSON-RPC Request Example description: JSON-RPC request body description: 'Unsubscribe from all the channels subscribed so far. This method takes no parameters. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Funsubscribe_all) ' x-mint: metadata: title: public/unsubscribe_all og:title: public/unsubscribe_all keywords: - public/unsubscribe_all href: /api-reference/subscription-management/public-unsubscribe_all /public/hello: get: parameters: - name: client_name in: query schema: type: string example: My Trading Software required: true description: Client software name - name: client_version in: query schema: type: string example: 1.0.2 required: true description: Client software version responses: '200': $ref: '#/components/responses/PublicTestResponse' tags: - Public requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 2841 method: public/hello params: client_name: My Trading Software client_version: 1.0.2 description: JSON-RPC Request Example description: JSON-RPC request body description: 'Method used to introduce the client software connected to Deribit platform over websocket. Provided data may have an impact on the maintained connection and will be collected for internal statistical purposes. In response, Deribit will also introduce itself. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fhello) ' x-mint: metadata: title: public/hello og:title: public/hello keywords: - public/hello - client_name - client_version - version href: /api-reference/supporting/public-hello /public/status: get: parameters: [] responses: '200': $ref: '#/components/responses/PublicStatusResponse' tags: - Public requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 55 method: public/status params: {} description: JSON-RPC Request Example description: JSON-RPC request body description: 'Method used to get information about locked currencies [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fstatus) ' x-mint: metadata: title: public/status og:title: public/status keywords: - public/status - locked - locked_indices href: /api-reference/supporting/public-status /public/test: get: parameters: - in: query name: expected_result required: false schema: type: string enum: - exception description: The value "exception" will trigger an error response. This may be useful for testing wrapper libraries. responses: '200': $ref: '#/components/responses/PublicTestResponse' tags: - Public requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 8212 method: public/test params: {} description: JSON-RPC Request Example description: JSON-RPC request body description: 'Tests the connection to the API server, and returns its version. You can use this to make sure the API is reachable, and matches the expected version. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Ftest) ' x-mint: metadata: title: public/test og:title: public/test keywords: - public/test - expected_result - version href: /api-reference/supporting/public-test /public/get_time: get: parameters: [] responses: '200': $ref: '#/components/responses/PublicGetTimeResponse' tags: - Public requestBody: content: application/json: examples: request: value: jsonrpc: '2.0' id: 7365 method: public/get_time params: {} description: JSON-RPC Request Example description: JSON-RPC request body description: 'Retrieves the current time (in milliseconds). This API endpoint can be used to check the clock skew between your software and Deribit''s systems. [Try in API console](https://test.deribit.com/api_console?method=%2Fpublic%2Fget_time) ' x-mint: metadata: title: public/get_time og:title: public/get_time keywords: - public/get_time href: /api-reference/supporting/public-get_time components: schemas: bids: items: items: type: number minItems: 2 maxItems: 2 type: array description: List of bids (price-amount pairs) type: array PublicTradesHistoryResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: object properties: trades: type: array items: $ref: '#/components/schemas/public_trade' has_more: type: boolean required: - trades - has_more required: - jsonrpc - result type: object settlement_type: enum: - settlement - delivery - bankruptcy type: string description: The type of settlement. `settlement`, `delivery` or `bankruptcy`. trades_volumes: properties: currency: $ref: '#/components/schemas/currency' calls_volume: example: 20.1 type: number description: Total 24h trade volume for call options. puts_volume: example: 60.2 type: number description: Total 24h trade volume for put options. futures_volume: example: 30.5178 type: number description: Total 24h trade volume for futures. spot_volume: example: 11.6 type: number description: Total 24h trade for spot. calls_volume_7d: example: 75.6 type: number description: Total 7d trade volume for call options. puts_volume_7d: example: 356.9 type: number description: Total 7d trade volume for put options. futures_volume_7d: example: 213.8841 type: number description: Total 7d trade volume for futures. spot_volume_7d: example: 64.8 type: number description: Total 7d trade for spot. calls_volume_30d: example: 547.3 type: number description: Total 30d trade volume for call options. puts_volume_30d: example: 785.5 type: number description: Total 30d trade volume for put options. futures_volume_30d: example: 998.2128 type: number description: Total 30d trade volume for futures. spot_volume_30d: example: 310.5 type: number description: Total 30d trade for spot. required: - currency - futures_volume - puts_volume - calls_volume type: object continuation: example: xY7T6cutS3t2B9YtaDkE6TS379oKnkzTvmEDUnEUP2Msa9xKWNNaT type: string description: Continuation token for pagination. PublicGetComboIdsResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: array items: $ref: '#/components/schemas/combo_id' required: - jsonrpc - result type: object PublicGetIndexPriceResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: properties: index_price: example: 11628.81 type: number description: Value of requested index estimated_delivery_price: example: 11628.81 type: number description: Estimated delivery price for the market. For more details, see Documentation > General > Expiration Price required: - index_price - estimated_delivery_price type: object required: - jsonrpc - result type: object book_state: enum: - open - settlement - delivered - inactive - locked - halted - archivized type: string description: 'The state of the order book. Represents the current lifecycle stage of the instrument. **State Lifecycle and Meanings:** - `open`: Default state for running books. In this state book is accepting new orders, edits, cancels; prices should be updated, trading is live. - `settlement`: Books enters to this state during settlement/delivery. New orders, edits, cancels are not accepted. After this state normally next state should be `open` if it was settlement, or `delivered` if it was delivery. On enter to this state good till day orders in book are canceled. - `delivered`: Final state of book that has been delivered. New orders, edits, cancels are not accepted. After some time book process will be terminated and, instrument moved to `expired_instruments` and its `instrument_state` will become archivized. On enter to this all open orders in book are canceled. - `inactive`: After a book is deactivated, this state is set on book. New orders, edits, cancels are not accepted. On enter to this all open orders in book are canceled. Book in this state is not considered as open. This can be also final state for book. - `locked`: New orders, edits, are not accepted, only cancels ARE accepted. In some cases when configured books can start as locked or it may become locked on admin request. Settlement is possible on locked books. - `halted`: The state that books enter as a result of an error. Settlement is not possible when there is at least one book in this state. - `archivized`: Set when instrument is moved to `expired_instruments` table, final state. ' PublicGetTimeResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: integer example: 1517329113791 description: Current timestamp (milliseconds since the UNIX epoch) required: - jsonrpc - result type: object combo_id: example: BTC-FS-31DEC21-PERP type: string description: Unique combo identifier currency_with_any_and_grouped: enum: - BTC - ETH - USDC - SOL - USDT - EURR - XRP - STETH - USYC - PAXG - BNB - USDE - any - grouped type: string description: Currency name or `"any"` if don't care or `"grouped"` if grouped by currencies api_key_features: items: type: string type: array description: 'List of enabled advanced on-key features.

Available options:
- restricted_block_trades: Limit the block_trade read the scope of the API key to block trades that have been made using this specific API key
- block_trade_approval: Block trades created using this API key require additional user approval. Methods that use block_rfq scope are not affected by Block Trade approval feature' kind_with_combo_all: enum: - future - option - spot - future_combo - option_combo - combo - any type: string description: 'Instrument kind: `"future"`, `"option"`, `"spot"`, `"future_combo"`, `"option_combo"`, `"combo"` for any combo or `"any"` for all' PublicGetBlockRfqTradesResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: properties: block_rfqs: type: array items: type: object properties: id: type: integer description: ID of the Block RFQ timestamp: $ref: '#/components/schemas/trade_timestamp' direction: $ref: '#/components/schemas/direction' description: Trade direction of the taker amount: type: number description: This value multiplied by the ratio of a leg gives trade size on that leg. mark_price: type: number description: Mark Price at the moment of trade legs: $ref: '#/components/schemas/leg_structure' combo_id: $ref: '#/components/schemas/combo_id' hedge: $ref: '#/components/schemas/block_rfq_hedge_leg' index_prices: type: object description: A map of index prices for the underlying instrument(s) at the time of trade execution, where keys are price index names and values are prices. trades: type: array items: type: object properties: direction: $ref: '#/components/schemas/direction' price: $ref: '#/components/schemas/price' amount: type: number description: Trade amount. For options, linear futures, linear perpetuals and spots the amount is denominated in the underlying base currency coin. The inverse perpetuals and inverse futures are denominated in USD units. hedge_amount: type: number description: Amount of the hedge leg. For linear futures, linear perpetuals and spots the amount is denominated in the underlying base currency coin. The inverse perpetuals and inverse futures are denominated in USD units. continuation: $ref: '#/components/schemas/block_rfq_trade_tape_continuation' type: object required: - jsonrpc - result type: object PublicTestResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: object properties: version: example: 2.1.26 type: string description: The API version required: - version required: - jsonrpc - result type: object PublicGetCombosResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: array items: $ref: '#/components/schemas/combo' required: - jsonrpc - result type: object open_interest: type: number description: The total amount of outstanding contracts in the corresponding amount units. For perpetual and inverse futures the amount is in USD units. For options and linear futures it is the underlying base currency coin. sorting: enum: - asc - desc - default type: string combo_state: enum: - active - inactive type: string description: 'Combo state: `"active"`, "`inactive`"' price: type: number description: Price in base currency PublicGetFundingRateValueResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: number required: - jsonrpc - result type: object PublicGetIndexPriceNamesResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: array items: type: object properties: name: type: string description: Index name future_combo_creation_enabled: type: boolean description: Whether future combo creation is enabled for this index (only present when `extended`=`true`) option_combo_creation_enabled: type: boolean description: Whether option combo creation is enabled for this index (only present when `extended`=`true`) required: - name required: - jsonrpc - result type: object stats: properties: volume: type: number description: Volume during last 24h in base currency low: type: number description: Lowest price during 24h high: type: number description: Highest price during 24h price_change: example: 10.23 type: number description: 24-hour price change expressed as a percentage, `null` if there weren't any trades volume_usd: $ref: '#/components/schemas/volume_usd' required: - volume - high - low type: object PublicGetAnnouncementsResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: array items: properties: body: example: An announcement type: string description: The HTML body of the announcement publication_timestamp: example: 1527844253000 type: integer description: The timestamp (milliseconds since the Unix epoch) of announcement publication id: example: 19288317 type: number description: A unique identifier for the announcement important: example: false type: boolean description: Whether the announcement is marked as important confirmation: type: boolean example: false description: Whether the user confirmation is required for this announcement title: example: Example announcement type: string description: The title of the announcement required: - title - body - important - id - publication_timestamp type: object required: - jsonrpc - result type: object PublicGetIndexChartDataResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: array description: "**Response:**\nThe response returns an array of data points, where each data point is an array containing:\n\n- **Index 0**: Timestamp in milliseconds since the Unix epoch\n- **Index 1**: Average index price at that timestamp\n\nExample response structure:\n```json\n[\n [1573228800000, 8751.7138636],\n [1573232400000, 8751.7138636],\n [1573236000000, 8751.7138636]\n]\n```\n\nEach entry in the result array represents a single data point:\n\n- The first value (timestamp) indicates when the price was recorded\n- The second value (price) is the average index price at that timestamp\n\nThe data points are returned in chronological order, making them ready for direct use in charting libraries.\n" required: - jsonrpc - result type: object block_trade_id_in_result: example: '154' type: string description: Block trade id - when trade was part of a block trade best_ask_amount: nullable: true type: number description: It represents the requested order size of all best asks PublicGetTradesVolumesResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: array items: $ref: '#/components/schemas/trades_volumes' required: - jsonrpc - result type: object PublicGetVolatilityIndexDataResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: object properties: data: type: array description: Candles as an array of arrays with 5 values each. The inner values correspond to the timestamp in ms, open, high, low, and close values of the volatility index correspondingly. continuation: type: integer description: Continuation - to be used as the `end_timestamp` parameter on the next request. `NULL` when no continuation. description: Volatility index candles. required: - jsonrpc - result type: object trade_id: type: string description: Unique (per currency) trade identifier block_rfq_trade_tape_continuation: example: 1738050297271:103 type: string description: Continuation token for pagination. `NULL` when no continuation. Consists of `timestamp` and `block_rfq_id`. settlement_price: type: number description: Optional (not added for spot). The settlement price for the instrument. Only when `state = open` TickerNotificationWithBidsAndAsks: properties: instrument_name: $ref: '#/components/schemas/instrument_name' timestamp: $ref: '#/components/schemas/timestamp' state: $ref: '#/components/schemas/book_state' stats: $ref: '#/components/schemas/stats' open_interest: $ref: '#/components/schemas/open_interest' best_bid_price: $ref: '#/components/schemas/best_bid_price' best_bid_amount: $ref: '#/components/schemas/best_bid_amount' best_ask_price: $ref: '#/components/schemas/best_ask_price' best_ask_amount: $ref: '#/components/schemas/best_ask_amount' index_price: $ref: '#/components/schemas/index_price' min_price: $ref: '#/components/schemas/min_price' max_price: $ref: '#/components/schemas/max_price' mark_price: $ref: '#/components/schemas/mark_price' last_price: $ref: '#/components/schemas/last_price' underlying_price: $ref: '#/components/schemas/underlying_price' underlying_index: $ref: '#/components/schemas/underlying_index' interest_rate: $ref: '#/components/schemas/interest_rate' bid_iv: $ref: '#/components/schemas/bid_iv' ask_iv: $ref: '#/components/schemas/ask_iv' mark_iv: $ref: '#/components/schemas/mark_iv' greeks: $ref: '#/components/schemas/greeks' funding_8h: $ref: '#/components/schemas/funding_8h' current_funding: $ref: '#/components/schemas/current_funding' delivery_price: $ref: '#/components/schemas/delivery_price' settlement_price: $ref: '#/components/schemas/settlement_price' bids: $ref: '#/components/schemas/bids' asks: $ref: '#/components/schemas/asks' required: - instrument_name - timestamp - state - stats - open_interest - index_price - best_bid_price - best_bid_amount - best_ask_price - best_ask_amount - min_price - max_price - mark_price - last_price - bids - asks type: object interest_rate: type: number description: Interest rate used in implied volatility calculations (options only) timestamp: example: 1536569522277 type: integer description: The timestamp (milliseconds since the Unix epoch) instrument_id: type: integer description: Instrument ID underlying_price: type: number description: Underlying price for implied volatility calculations (options only) contract_size: example: 10 type: integer description: Contract size, for futures in USD, for options in base currency of the instrument (BTC, ETH, ...) PublicGetBookSummaryResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: array items: $ref: '#/components/schemas/book_summary' required: - jsonrpc - result type: object currency: enum: - BTC - ETH - USDC - USDT - EURR type: string description: Currency, i.e `"BTC"`, `"ETH"`, `"USDC"` bid_iv: type: number description: (Only for option) implied volatility for best bid settlement: properties: funding: example: -2.511e-06 type: number description: funding (in base currency ; settlement for perpetual product only) funded: example: 0 type: number description: funded amount (bankruptcy only) index_price: example: 11008.37 type: number description: underlying index price at time of event (in quote currency; settlement and delivery only) instrument_name: example: BTC-30MAR18 type: string description: instrument name (settlement and delivery only) mark_price: example: 11000 type: number description: mark price for at the settlement time (in quote currency; settlement and delivery only) position: example: 1000 type: number description: position size (in quote currency; settlement and delivery only) profit_loss: example: 0 type: number description: profit and loss (in base currency; settlement and delivery only) session_bankruptcy: example: 0.001160788 type: number description: value of session bankruptcy (in base currency; bankruptcy only) session_profit_loss: example: 0.001160788 type: number description: total value of session profit and losses (in base currency) session_tax: example: -0.001160788 type: number description: total amount of paid taxes/fees (in base currency; bankruptcy only) session_tax_rate: example: 0.000103333 type: number description: rate of paid taxes/fees (in base currency; bankruptcy only) socialized: example: -0.001160788 type: number description: the amount of the socialized losses (in base currency; bankruptcy only) timestamp: $ref: '#/components/schemas/timestamp' type: $ref: '#/components/schemas/settlement_type' required: - type - timestamp - session_profit_loss - position - instrument_name - index_price - funding type: object direction: enum: - buy - sell type: string description: 'Direction: `buy`, or `sell`' currency_with_any: enum: - BTC - ETH - USDC - USDT - EURR - any type: string description: Currency name or `"any"` if don't care PrivateSubscribeResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: array items: type: string example: deribit_price_index.btc_usd description: A list of subscribed channels. required: - jsonrpc - result type: object PublicGetOrderBookResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: $ref: '#/components/schemas/TickerNotificationWithBidsAndAsks' required: - jsonrpc - result type: object block_trade_leg_count: example: 3 type: integer description: Block trade leg count - when trade was part of a block trade volume_usd: type: number description: Volume in usd (futures only) book_summary: properties: instrument_name: $ref: '#/components/schemas/instrument_name' high: example: 7022.89 type: number description: Price of the 24h highest trade low: example: 7022.89 type: number description: Price of the 24h lowest trade, `null` if there weren't any trades base_currency: example: ETH type: string description: Base currency quote_currency: example: USD type: string description: Quote currency volume: example: 223 type: number description: The total 24h traded volume (in base currency) bid_price: example: 7022.89 type: number description: The current best bid price, `null` if there aren't any bids ask_price: example: 7022.89 type: number description: The current best ask price, `null` if there aren't any asks mid_price: example: 7022.89 type: number description: The average of the best bid and ask, `null` if there aren't any asks or bids mark_price: example: 7022.89 type: number description: The current instrument market price last: example: 7022.89 type: number description: The price of the latest trade, `null` if there weren't any trades open_interest: example: 0.5 type: number description: Optional (only for derivatives). The total amount of outstanding contracts in the corresponding amount units. For perpetual and inverse futures the amount is in USD units. For options and linear futures it is the underlying base currency coin. creation_timestamp: $ref: '#/components/schemas/timestamp' estimated_delivery_price: example: 11628.81 type: number description: Optional (only for derivatives). Estimated delivery price for the market. volume_usd: type: number description: Volume in USD volume_notional: type: number description: Volume in quote currency (futures and spots only) current_funding: type: number example: 0.12344 description: Current funding (perpetual only) funding_8h: type: number description: Funding 8h (perpetual only) mark_iv: $ref: '#/components/schemas/mark_iv' interest_rate: example: 0 type: number description: Interest rate used in implied volatility calculations (options only) underlying_index: example: index_price type: string description: Name of the underlying future, or `'index_price'` (options only) underlying_price: example: 6745.34 type: number description: underlying price for implied volatility calculations (options only) price_change: example: 10.23 type: number description: 24-hour price change expressed as a percentage, `null` if there weren't any trades required: - instrument_name - high - low - base_currency - quote_currency - volume - bid_price - ask_price - mid_price - mark_price - last - open_interest - creation_timestamp type: object instrument_name: example: BTC-PERPETUAL type: string description: Unique instrument identifier mark_iv: type: number description: (Only for option) implied volatility for mark price current_funding: type: number description: Current funding (perpetual only) funding_8h: type: number description: Funding 8h (perpetual only) PublicGetMarkPriceHistoryResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: array description: Markprice history values as an array of arrays with 2 values each. The inner values correspond to the timestamp in ms and the markprice itself. required: - jsonrpc - result type: object PublicGetInstrumentsResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: array items: $ref: '#/components/schemas/instrument' required: - jsonrpc - result type: object delivery_price: type: number description: The settlement price for the instrument. Only when `state = closed` price_index: example: btc_usdc type: string description: Name of price index that is used for this instrument combo_leg: properties: instrument_name: $ref: '#/components/schemas/instrument_name' amount: $ref: '#/components/schemas/combo_leg_amount' type: object mark_price: type: number description: The mark price for the instrument instrument: properties: kind: $ref: '#/components/schemas/kind' settlement_currency: type: string enum: - BTC - ETH description: Optional (not added for spot). Settlement currency for the instrument. counter_currency: type: string enum: - USD - USDC description: Counter currency for the instrument. base_currency: type: string enum: - BTC - ETH description: The underlying currency being traded. quote_currency: type: string enum: - USD description: The currency in which the instrument prices are quoted. min_trade_amount: type: number example: 0.1 description: Minimum amount for trading. For perpetual and inverse futures the amount is in USD units. For options and linear futures it is the underlying base currency coin. instrument_name: $ref: '#/components/schemas/instrument_name' instrument_id: $ref: '#/components/schemas/instrument_id' is_active: type: boolean description: Indicates if the instrument can currently be traded. settlement_period: type: string enum: - month - week - perpetual description: Optional (not added for spot). The settlement period. creation_timestamp: type: integer example: 1536569522277 description: The time when the instrument was first created (milliseconds since the UNIX epoch). tick_size: type: number example: 0.0001 description: Specifies minimal price change and, as follows, the number of decimal places for instrument prices. tick_size_steps: $ref: '#/components/schemas/tick_size_step' expiration_timestamp: type: integer description: The time when the instrument will expire (milliseconds since the UNIX epoch). strike: type: number description: The strike value (only for options). option_type: type: string enum: - call - put description: The option type (only for options). future_type: type: string enum: - linear - reversed description: Future type (only for futures)(field is deprecated and will be removed in the future, `instrument_type` should be used instead). instrument_type: type: string description: Type of the instrument. `linear` or `reversed` contract_size: type: integer example: 1 description: Contract size for instrument. maker_commission: type: number example: 0.0001 description: Maker commission for instrument. taker_commission: type: number example: 0.0005 description: Taker commission for instrument. max_liquidation_commission: type: number example: 0.001 description: Maximal liquidation trade commission for instrument (only for futures). block_trade_commission: type: number example: 0.0005 description: Block Trade commission for instrument. block_trade_tick_size: type: number example: 0.01 description: Specifies minimal price change for block trading. block_trade_min_trade_amount: type: number example: 25 description: Minimum amount for block trading. max_leverage: type: integer example: 100 description: Maximal leverage for instrument (only for futures). price_index: $ref: '#/components/schemas/price_index' state: $ref: '#/components/schemas/book_state' required: - kind - base_currency - quote_currency - min_trade_amount - instrument_name - is_active - settlement_period - creation_timestamp - tick_size - expiration_timestamp - contract_size - price_index type: object settlement_currency_with_any_and_grouped: enum: - BTC - ETH - USDC - USDT - any - grouped type: string description: Currency name or `"any"` if don't care or `"grouped"` if grouped by currencies best_bid_amount: nullable: true type: number description: It represents the requested order size of all best bids kind_future_or_option_with_any: enum: - future - option - any type: string description: 'Instrument kind: `"future"`, `"option"` or `"any"` for all' PublicGetComboDetailsResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: $ref: '#/components/schemas/combo' required: - jsonrpc - result type: object combo_leg_amount: example: -1 type: integer description: Size multiplier of a leg. A negative value indicates that the trades on given leg are in opposite direction to the combo trades they originate from PublicAuthResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: object properties: access_token: type: string example: 843SehgeX5n6XxEU4XbABx4Cny5Akai5iHiJePTsvUw7 description: OAuth access token to be used for authentication of 'private' requests token_type: type: string enum: - bearer description: Authorization type, allowed value - `bearer` expires_in: type: integer example: 315360000 description: Token lifetime in seconds refresh_token: type: string example: 6faf8L36JdaSqsjCEEiwqifPpj6JB18RWwiWHrsGTZ91 description: Can be used to request a new token (with a new lifetime) scope: type: string description: Type of the access for assigned token state: type: string description: Copied from the input (if applicable) sid: type: string description: Optional Session id enabled_features: $ref: '#/components/schemas/api_key_features' mandatory_tfa_status: type: string example: enabled description: 2FA is required for privileged methods google_login: type: boolean description: The access token was acquired by logging in through Google. required: - access_token - token_type - expires_in - refresh_token - scope required: - jsonrpc - result type: object tick_direction: enum: - 0 - 1 - 2 - 3 type: integer description: Direction of the "tick" (`0` = Plus Tick, `1` = Zero-Plus Tick, `2` = Minus Tick, `3` = Zero-Minus Tick). block_rfq_hedge_leg: properties: amount: type: integer description: It represents the requested hedge leg size. For perpetual and inverse futures the amount is in USD units. For options and linear futures it is the underlying base currency coin. instrument_name: type: string example: BTC-PERPETUAL description: Unique instrument identifier direction: type: string enum: - buy - sell description: 'Direction: `buy`, or `sell`' price: type: number description: Price for a hedge leg type: object currency_with_apr: properties: withdrawal_fee: type: number example: 0.0001 description: The total transaction fee paid for withdrawals withdrawal_priorities: type: array items: $ref: '#/components/schemas/key_number_pair' min_withdrawal_fee: type: number example: 0.0001 description: The minimum transaction fee paid for withdrawals currency: type: string example: BTC description: The abbreviation of the currency. This abbreviation is used elsewhere in the API to identify the currency. currency_long: type: string example: Bitcoin description: The full name for the currency. min_confirmations: type: integer example: 2 description: Minimum number of block chain confirmations before deposit is accepted. coin_type: type: string enum: - BITCOIN - ETHER description: The type of the currency. in_cross_collateral_pool: type: boolean description: '`true` if the currency is part of the cross collateral pool' apr: type: number description: Simple Moving Average (SMA) of the last 7 days of rewards. If fewer than 7 days of reward data are available, the APR is calculated as the average of the available rewards. Only applicable to yield-generating tokens (`USDE`, `STETH`, `USDC`, `BUILD`). network_fee: type: number example: 0.0001 description: The network fee network_currency: type: string example: BTC description: The currency of the network decimals: type: integer example: 6 description: The number of decimal places for the currency required: - currency - currency_long - min_confirmations - withdrawal_fee - coin_type - in_cross_collateral_pool type: object PublicGetInstrumentResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: $ref: '#/components/schemas/instrument' required: - jsonrpc - result type: object PublicGetExpirationsResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: array items: $ref: '#/components/schemas/expirations' required: - jsonrpc - result type: object trade_timestamp: example: 1517329113791 type: integer description: The timestamp of the trade (milliseconds since the UNIX epoch) PublicGetFundingChartDataResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: object properties: current_interest: type: number example: 0.005000670552845 description: Current interest interest_8h: type: number example: 0.0040080896931 description: Current interest 8h data: type: array items: type: object properties: timestamp: $ref: '#/components/schemas/timestamp' index_price: $ref: '#/components/schemas/index_price' interest_8h: type: number example: 0.004999511380756577 description: Historical interest 8h value required: - timestamp - index_price - interest_8h required: - current_interest - data - interest_8h required: - jsonrpc - result type: object PublicGetHistoricalVolatilityResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: array items: type: object properties: timestamp: type: integer value: type: number required: - timestamp - value required: - jsonrpc - result type: object greeks: properties: delta: type: number description: "(Only for option) The delta value for the option. This is the **Black Scholes Delta** for individual option expiries. \n\nNote that DeltaTotal in account summary uses Net Transaction Delta instead. See the greeks object description for more details.\n" gamma: type: number description: '(Only for option) The gamma value for the option. Calculated using standard Black Scholes without adjustments. Gamma measures the rate of change of delta with respect to changes in the underlying asset price. ' rho: type: number description: '(Only for option) The rho value for the option. Calculated using standard Black Scholes without adjustments. Rho measures the sensitivity of the option price to changes in the risk-free interest rate. ' theta: type: number description: '(Only for option) The theta value for the option. Deribit uses the **minimum of (1 day Theta, lifetime theta of the option)**. So if you take an option with 1 hour to expire for example, generally Black Scholes Theta will give you the equivalent 1 day Theta. Whereas we show the 1 hour Theta, so our Theta would differ from Black Scholes Theta when time to expiry is less than 1 day. Theta measures the rate of change of the option price with respect to time decay. ' vega: type: number description: '(Only for option) The vega value for the option. Calculated using standard Black Scholes without adjustments. Vega (not actually a Greek symbol) measures the sensitivity of the option price to changes in implied volatility. ' required: - delta - gamma - rho - theta - vega type: object description: 'Only for options. Greeks are risk measures that describe how the option''s price changes with respect to various factors. **Delta (Δ)** Deribit uses two different Deltas: - **DeltaTotal** in the account summary uses the **Net Transaction Delta (NTD)** - **Delta** for individual option expiries is the **Black Scholes Delta** In the settings section you can toggle Net Transaction Delta instead. **What is DeltaTotal in the account summary?** `DeltaTotal = Net Transaction Delta of options + BTC Position of Futures` **What is Net Transaction Delta?** `Net Transaction Delta = Black Scholes Delta - Mark Price of Options` **Why do we use a Net Transaction Delta?** The Delta Total uses the Net Transaction Delta (or price adjusted Delta) of the options. This is because, from a risk perspective, we are interested in the change in Bitcoin price as the underlying changes. You should actually treat your delta as **Equity + Delta Total** if you want to have less risk for your USD PnL. **Example:** Consider a call option with strike 0, which has a Black Scholes Delta of 1 and Net Transaction Delta = 0. Imagine you have 2 BTC equity and no positions and BTC price is at USD 60k. In that case you would short 2 Futures contracts to hedge your USD exposure to BTC. Now let''s say you buy one call with strike 0. The question is if you should sell another future? The call will always have a price of 1 BTC. So you buy it at 1 BTC which equates to USD 60k. Let''s say the price increases to USD 70k. The value of the call is still 1 BTC. At settlement you receive 1 BTC for the call. So you paid 1 BTC and then receive 1 BTC which means your USD PnL on buying the call is 0. If you sold a future on it, then you would actually lose on the future. ⚠️ **During the 30 minute settlement period we decay your Delta.** See [Delta decay during settlement](https://support.deribit.com/hc/en-us/articles/25944751433757-Delta-decay-during-settlement) for more details. **Theta (Θ)** The Theta that Deribit uses is the **minimum of (1 day Theta, lifetime theta of the option)**. So if you take an option with 1 hour to expire for example, generally Black Scholes Theta will give you the equivalent 1 day Theta. Whereas we show the 1 hour Theta, so our Theta would differ from Black Scholes Theta when time to expiry is less than 1 day. **Vega, Gamma, and Rho** Vega (not actually a Greek symbol), Gamma, Theta and Rho values shown on Deribit are calculated using **standard Black Scholes without adjustments**. ' ErrorMessageResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request message: type: string error: type: integer required: - jsonrpc - message - error type: object max_price: type: number description: The maximum price for the future. Any buy orders you submit higher than this price, will be clamped to this maximum. PublicGetContractSizeResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: object properties: contract_size: $ref: '#/components/schemas/contract_size' required: - contract_size required: - jsonrpc - result type: object PublicGetFundingRateHistoryResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: array items: type: object properties: timestamp: $ref: '#/components/schemas/timestamp' prev_index_price: $ref: '#/components/schemas/price' index_price: $ref: '#/components/schemas/price' interest_1h: type: number description: 1hour interest rate interest_8h: type: number description: 8hour interest rate required: - jsonrpc - result type: object key_number_pair: properties: name: type: string value: type: number required: - name - value type: object PublicTickerResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: $ref: '#/components/schemas/TickerNotification' required: - jsonrpc - result type: object best_ask_price: nullable: true type: number description: The current best ask price, `null` if there aren't any asks best_bid_price: nullable: true type: number description: The current best bid price, `null` if there aren't any bids trade_seq: type: integer description: The sequence number of the trade within instrument index_name: enum: - btc_usd - eth_usd - ada_usdc - algo_usdc - avax_usdc - bch_usdc - bnb_usdc - btc_usdc - btcdvol_usdc - buidl_usdc - doge_usdc - dot_usdc - eurr_usdc - eth_usdc - ethdvol_usdc - link_usdc - ltc_usdc - near_usdc - paxg_usdc - shib_usdc - sol_usdc - steth_usdc - ton_usdc - trump_usdc - trx_usdc - uni_usdc - usde_usdc - usyc_usdc - xrp_usdc - btc_usdt - eth_usdt - eurr_usdt - sol_usdt - steth_usdt - usdc_usdt - usde_usdt - btc_eurr - btc_usde - btc_usyc - eth_btc - eth_eurr - eth_usde - eth_usyc - steth_eth - paxg_btc - drbfix-btc_usdc - drbfix-eth_usdc type: string description: Index identifier, matches (base) cryptocurrency with quote currency PublicTokenResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: object properties: access_token: type: string example: 843SehgeX5n6XxEU4XbABx4Cny5Akai5iHiJePTsvUw7 token_type: type: string enum: - bearer description: Authorization type, allowed value - `bearer` expires_in: type: integer example: 315360000 description: Token lifetime in seconds refresh_token: type: string example: 6faf8L36JdaSqsjCEEiwqifPpj6JB18RWwiWHrsGTZ91 description: Can be used to request a new token (with a new lifetime) scope: type: string description: Type of the access for assigned token sid: type: string description: Optional Session id required: - access_token - token_type - expires_in - refresh_token - scope required: - jsonrpc - result type: object public_trade: properties: trade_id: $ref: '#/components/schemas/trade_id' trade_seq: $ref: '#/components/schemas/trade_seq' instrument_name: $ref: '#/components/schemas/instrument_name' timestamp: $ref: '#/components/schemas/trade_timestamp' direction: $ref: '#/components/schemas/direction' description: Trade direction of the taker tick_direction: $ref: '#/components/schemas/tick_direction' index_price: type: number description: Index Price at the moment of trade price: $ref: '#/components/schemas/price' description: The price of the trade amount: type: number description: Trade amount. For perpetual and inverse futures the amount is in USD units. For options and linear futures it is the underlying base currency coin. contracts: type: number description: Trade size in contract units (optional, may be absent in historical trades) iv: type: number description: Option implied volatility for the price (Option only) liquidation: type: string enum: - M - T - MT description: 'Optional field (only for trades caused by liquidation): `"M"` when maker side of trade was under liquidation, `"T"` when taker side was under liquidation, `"MT"` when both sides of trade were under liquidation' mark_price: type: number description: Mark Price at the moment of trade block_trade_id: $ref: '#/components/schemas/block_trade_id_in_result' block_trade_leg_count: $ref: '#/components/schemas/block_trade_leg_count' combo_id: type: string description: Optional field containing combo instrument name if the trade is a combo trade combo_trade_id: type: number description: Optional field containing combo trade identifier if the trade is a combo trade block_rfq_id: type: integer description: ID of the Block RFQ - when trade was part of the Block RFQ required: - trade_id - instrument_name - timestamp - trade_seq - direction - tick_direction - index_price - price - amount - mark_price type: object Getunsubscribe200response: type: object properties: jsonrpc: type: string example: '2.0' id: type: integer example: 8691 result: type: array items: type: string x-deribit-type: channel example: - deribit_price_index.btc_usd description: List of channels that were successfully unsubscribed in this request ask_iv: type: number description: (Only for option) implied volatility for best ask PublicSettlementResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: properties: continuation: $ref: '#/components/schemas/continuation' settlements: type: array items: $ref: '#/components/schemas/settlement' required: - continuation - settlements type: object required: - jsonrpc - result type: object kind: enum: - future - option - spot - future_combo - option_combo type: string description: 'Instrument kind: `"future"`, `"option"`, `"spot"`, `"future_combo"`, `"option_combo"`' tick_size_step: properties: above_price: type: number description: The price from which the increased tick size applies tick_size: type: number description: Tick size to be used above the price. It must be multiple of the minimum tick size. type: object combo: properties: id: $ref: '#/components/schemas/combo_id' instrument_id: $ref: '#/components/schemas/instrument_id' state: $ref: '#/components/schemas/combo_state' state_timestamp: $ref: '#/components/schemas/timestamp' creation_timestamp: $ref: '#/components/schemas/timestamp' legs: type: array items: $ref: '#/components/schemas/combo_leg' type: object min_price: type: number description: The minimum price for the future. Any sell orders you submit lower than this price will be clamped to this minimum. OkResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: string enum: - ok description: Result of method execution. `ok` in case of success required: - jsonrpc - result type: object underlying_index: type: number description: Name of the underlying future, or `index_price` (options only) TickerNotification: properties: instrument_name: $ref: '#/components/schemas/instrument_name' timestamp: $ref: '#/components/schemas/timestamp' state: $ref: '#/components/schemas/book_state' stats: $ref: '#/components/schemas/stats' open_interest: $ref: '#/components/schemas/open_interest' best_bid_price: $ref: '#/components/schemas/best_bid_price' best_bid_amount: $ref: '#/components/schemas/best_bid_amount' best_ask_price: $ref: '#/components/schemas/best_ask_price' best_ask_amount: $ref: '#/components/schemas/best_ask_amount' index_price: $ref: '#/components/schemas/index_price' min_price: $ref: '#/components/schemas/min_price' max_price: $ref: '#/components/schemas/max_price' mark_price: $ref: '#/components/schemas/mark_price' last_price: $ref: '#/components/schemas/last_price' underlying_price: $ref: '#/components/schemas/underlying_price' underlying_index: $ref: '#/components/schemas/underlying_index' interest_rate: $ref: '#/components/schemas/interest_rate' bid_iv: $ref: '#/components/schemas/bid_iv' ask_iv: $ref: '#/components/schemas/ask_iv' mark_iv: $ref: '#/components/schemas/mark_iv' greeks: $ref: '#/components/schemas/greeks' funding_8h: $ref: '#/components/schemas/funding_8h' current_funding: $ref: '#/components/schemas/current_funding' interest_value: $ref: '#/components/schemas/interest_value' delivery_price: $ref: '#/components/schemas/delivery_price' settlement_price: $ref: '#/components/schemas/settlement_price' estimated_delivery_price: $ref: '#/components/schemas/estimated_delivery_price' required: - instrument_name - timestamp - state - stats - open_interest - index_price - best_bid_price - best_bid_amount - best_ask_price - best_ask_amount - min_price - max_price - mark_price - last_price - estimated_delivery_price type: object expirations: properties: currency: $ref: '#/components/schemas/currency_with_any_and_grouped' kind: $ref: '#/components/schemas/kind_future_or_option_with_any' type: object description: A map where each key is valid currency (e.g. btc, eth, usdc), and the value is a list of expirations or a map where each key is a valid kind (future or options) and value is a list of expirations from every instrument estimated_delivery_price: example: 11628.81 type: number description: Estimated delivery price for the market. For more details, see Contract Specification > General Documentation > Expiration Price PublicGetTradingviewChartDataResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: object properties: status: type: string enum: - ok - no_data description: 'Status of the query: `ok` or `no_data`' ticks: type: array items: $ref: '#/components/schemas/timestamp' description: Values of the time axis given in milliseconds since UNIX epoch volume: type: array items: $ref: '#/components/schemas/chart_volume' description: List of volume bars (in base currency, one per candle) cost: type: array items: $ref: '#/components/schemas/chart_volume' description: List of cost bars (volume in quote currency, one per candle) open: type: array items: $ref: '#/components/schemas/quote_price' description: List of prices at open (one per candle) close: type: array items: $ref: '#/components/schemas/quote_price' description: List of prices at close (one per candle) high: type: array items: $ref: '#/components/schemas/quote_price' description: List of highest price levels (one per candle) low: type: array items: $ref: '#/components/schemas/quote_price' description: List of lowest price levels (one per candle) required: - jsonrpc - result type: object last_price: nullable: true type: number description: The price for the last trade PublicGetCurrenciesResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: array items: $ref: '#/components/schemas/currency_with_apr' required: - jsonrpc - result type: object leg_structure: items: properties: ratio: type: integer description: Ratio of amount between legs instrument_name: type: string example: BTC-PERPETUAL description: Unique instrument identifier direction: type: string enum: - buy - sell description: 'Direction: `buy`, or `sell`' price: type: number description: Price for a leg type: object type: array PublicStatusResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: type: object properties: locked: type: string description: '`true` when platform is locked in all currencies, `partial` when some currencies are locked, `false` - when there are not currencies locked' locked_indices: type: array description: List of currency indices locked platform-wise required: - locked required: - jsonrpc - result type: object quote_price: type: number description: Price in quote currency asks: items: items: type: number minItems: 2 maxItems: 2 type: array description: List of asks (price-amount pairs) type: array index_price: example: 8247.27 type: number description: Current index price chart_volume: type: number description: // todo PublicGetAprHistoryResponse: properties: jsonrpc: type: string enum: - '2.0' description: The JSON-RPC version (2.0) id: type: integer description: The id that was sent in the request result: properties: continuation: $ref: '#/components/schemas/continuation' data: type: array items: type: object properties: day: type: integer description: The full epoch day apr: type: number description: The APR of the day required: - data type: object required: - jsonrpc - result type: object interest_value: type: number description: Value used to calculate `realized_funding` in positions (perpetual only) responses: PublicGetComboDetailsResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetComboDetailsResponse' examples: response: value: jsonrpc: '2.0' id: 3 result: state_timestamp: 1650620605150 state: active legs: - instrument_name: BTC-PERPETUAL amount: -1 - instrument_name: BTC-29APR22 amount: 1 id: BTC-FS-29APR22_PERP instrument_id: 27 creation_timestamp: 1650620575000 description: Response example description: Success response PublicGetTradesVolumesResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetTradesVolumesResponse' examples: response: value: jsonrpc: '2.0' id: 6387 result: - puts_volume: 48 futures_volume: 6.25578452 currency: BTC calls_volume: 145 spot_volume: 11.1 - puts_volume: 122.65 futures_volume: 374.392173 currency: ETH calls_volume: 37.4 spot_volume: 57.7 description: Response example description: Success response PublicGetTimeResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetTimeResponse' examples: response: value: jsonrpc: '2.0' id: 7365 result: 1550147385946 description: Response example description: Success response PublicGetTradingviewChartDataResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetTradingviewChartDataResponse' examples: response: value: jsonrpc: '2.0' id: 833 result: volume: - 19.007942601 - 20.095877981 cost: - 19000 - 23400 ticks: - 1554373800000 - 1554375600000 status: ok open: - 4963.42 - 4986.29 low: - 4728.94 - 4726.6 high: - 5185.45 - 5250.87 close: - 5052.95 - 5013.59 usIn: 1554381680742493 usOut: 1554381680742698 usDiff: 205 testnet: false description: Response example description: Success response PublicGetCurrenciesResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetCurrenciesResponse' examples: response: value: jsonrpc: '2.0' id: 7538 result: - coin_type: ETHER currency: ETH currency_long: Ethereum min_confirmations: 1 min_withdrawal_fee: 0.0001 withdrawal_fee: 0.0006 withdrawal_priorities: [] network_currency: ETH network_fee: 0.0006 decimals: 6 - coin_type: BITCOIN currency: BTC currency_long: Bitcoin min_confirmations: 1 min_withdrawal_fee: 0.0001 withdrawal_fee: 0.0001 withdrawal_priorities: - value: 0.15 name: very_low - value: 1.5 name: very_high network_currency: BTC network_fee: 0.0001 decimals: 8 description: Response example description: Success response OkResponse: content: application/json: schema: $ref: '#/components/schemas/OkResponse' examples: response: value: jsonrpc: '2.0' id: 1569 result: ok description: Response example description: Success response PublicGetCombosResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetCombosResponse' examples: response: value: jsonrpc: '2.0' id: 2 result: - state_timestamp: 1650636265101 state: active legs: - instrument_name: BTC-29APR22-39300-C amount: 1 - instrument_name: BTC-29APR22-39600-C amount: -1 id: BTC-CS-29APR22-39300_39600 instrument_id: 28 creation_timestamp: 1650636235000 - state_timestamp: 1650620605150 state: active legs: - instrument_name: BTC-PERPETUAL amount: -1 - instrument_name: BTC-29APR22 amount: 1 id: BTC-FS-29APR22_PERP instrument_id: 27 creation_timestamp: 1650620575000 description: Response example description: Success response PublicGetMarkPriceHistoryResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetMarkPriceHistoryResponse' examples: response: value: jsonrpc: '2.0' id: 25 result: - - 1608142381229 - 0.5165791606037885 - - 1608142380231 - 0.5165737855432504 - - 1608142379227 - 0.5165768236356326 description: Response example description: Success response PublicGetContractSizeResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetContractSizeResponse' description: Success response PublicGetHistoricalVolatilityResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetHistoricalVolatilityResponse' examples: response: value: jsonrpc: '2.0' id: 8387 result: - - 1549720800000 - 14.747743607344217 - - 1549720800000 - 14.747743607344217 - - 1549724400000 - 14.74257778551467 - - 1549728000000 - 14.73502799931767 - - 1549731600000 - 14.73502799931767 - - 1549735200000 - 14.73502799931767 - - 1550228400000 - 46.371891307340015 description: Response example description: Success response PublicStatusResponse: content: application/json: schema: $ref: '#/components/schemas/PublicStatusResponse' examples: response: value: jsonrpc: '2.0' id: 55 result: locked_currencies: - BTC - ETH locked: true description: Response example description: Success response PublicGetInstrumentResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetInstrumentResponse' examples: response: value: jsonrpc: '2.0' id: 2 result: tick_size: 0.0005 tick_size_steps: - above_price: 120 tick_size: 0.001 - above_price: 200 tick_size: 0.003 taker_commission: 0.0003 strike: 16000 settlement_period: week settlement_currency: BTC quote_currency: BTC price_index: btc_usd option_type: put min_trade_amount: 0.1 maker_commission: 0.0003 kind: option is_active: true instrument_name: BTC-13JAN23-16000-P instrument_id: 144613 expiration_timestamp: 1673596800000 creation_timestamp: 1671696002000 counter_currency: USD contract_size: 1 block_trade_tick_size: 0.0001 block_trade_min_trade_amount: 25 block_trade_commission: 0.00015 base_currency: BTC state: open description: Response example description: Success response PublicGetAprHistoryResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetAprHistoryResponse' examples: response: value: jsonrpc: '2.0' id: 1 result: data: - day: 20200 apr: 2.814 - day: 20199 apr: 2.749 - day: 20198 apr: 2.684 - day: 20197 apr: 2.667 - day: 20196 apr: 2.722 continuation: 20196 description: Response example description: Success response PublicGetIndexPriceResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetIndexPriceResponse' description: Success response PublicAuthResponse: content: application/json: schema: $ref: '#/components/schemas/PublicAuthResponse' examples: response: value: jsonrpc: '2.0' id: 9929 result: access_token: 1582628593469.1MbQ-J_4.CBP-OqOwm_FBdMYj4cRK2dMXyHPfBtXGpzLxhWg31nHu3H_Q60FpE5_vqUBEQGSiMrIGzw3nC37NMb9d1tpBNqBOM_Ql9pXOmgtV9Yj3Pq1c6BqC6dU6eTxHMFO67x8GpJxqw_QcKP5IepwGBD-gfKSHfAv9AEnLJkNu3JkMJBdLToY1lrBnuedF3dU_uARm expires_in: 31536000 refresh_token: 1582628593469.1GP4rQd0.A9Wa78o5kFRIUP49mScaD1CqHgiK50HOl2VA6kCtWa8BQZU5Dr03BhcbXPNvEh3I_MVixKZXnyoBeKJwLl8LXnfo180ckAiPj3zOclcUu4zkXuF3NNP3sTPcDf1B3C1CwMKkJ1NOcf1yPmRbsrd7hbgQ-hLa40tfx6Oa-85ymm_3Z65LZcnCeLrqlj_A9jM scope: connection mainaccount enabled_features: [] token_type: bearer description: Response example description: Success response PublicGetComboIdsResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetComboIdsResponse' examples: response: value: jsonrpc: '2.0' id: 1 result: - BTC-CS-29APR22-39300_39600 - BTC-FS-29APR22_PERP description: Response example description: Success response PrivateSubscribeResponse: content: application/json: schema: $ref: '#/components/schemas/PrivateSubscribeResponse' examples: response: value: jsonrpc: '2.0' id: 4235 result: - deribit_price_index.btc_usd description: Response example description: Success response PublicTickerResponse: content: application/json: schema: $ref: '#/components/schemas/PublicTickerResponse' examples: response: value: jsonrpc: '2.0' id: 8106 result: best_ask_amount: 53040 best_ask_price: 36290 best_bid_amount: 4600 best_bid_price: 36289.5 current_funding: 0 estimated_delivery_price: 36297.02 funding_8h: 2.203e-05 index_price: 36297.02 instrument_name: BTC-PERPETUAL interest_value: 1.7362511643080387 last_price: 36289.5 mark_price: 36288.31 max_price: 36833.4 min_price: 35744.73 open_interest: 502231260 settlement_price: 36169.49 state: open stats: high: 36824.5 low: 35213.5 price_change: 0.2362 volume: 7831.26548117 volume_usd: 282615600 timestamp: 1623059681955 description: Response example description: Success response PublicSettlementResponse: content: application/json: schema: $ref: '#/components/schemas/PublicSettlementResponse' examples: response: value: jsonrpc: '2.0' id: 5482 result: settlements: - type: settlement timestamp: 1550502000023 session_profit_loss: 0.116509752 profit_loss: -9.999999999886402e-10 position: 240 mark_price: 3578.16 instrument_name: BTC-22FEB19 index_price: 3796.43 continuation: 2Z7mdtavzYvfuyYcHkJXvPTr9ZSMsEzM3sLCH7AbYEDd1AzTXY2hnhegQDiaP1TtU4b5iSJZ4 description: Response example description: Success response PublicGetBookSummaryResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetBookSummaryResponse' examples: response: value: jsonrpc: '2.0' id: 3659 result: - volume: 0.55 underlying_price: 121.38 underlying_index: index_price quote_currency: USD price_change: -26.7793594 open_interest: 0.55 mid_price: 0.2444 mark_price: 80 low: 0.34 last: 0.34 interest_rate: 0.207 instrument_name: ETH-22FEB19-140-P high: 0.34 creation_timestamp: 1550227952163 bid_price: 0.1488 base_currency: ETH ask_price: 0.34 description: Response example description: Success response PublicGetExpirationsResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetExpirationsResponse' examples: response: value: jsonrpc: '2.0' result: future: - 21SEP24 - 22SEP24 - PERPETUAL option: - 21SEP24 - 22SEP24 - 23SEP24 description: Response example description: Success response PublicGetFundingRateHistoryResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetFundingRateHistoryResponse' examples: response: value: jsonrpc: '2.0' id: 7617 result: - timestamp: 1569891600000 index_price: 8222.87 prev_index_price: 8305.72 interest_8h: -9.234260068476106e-05 interest_1h: -4.739622041017375e-07 - timestamp: 1569895200000 index_price: 8286.49 prev_index_price: 8222.87 interest_8h: -6.720918180255509e-05 interest_1h: -2.8583510923267753e-07 - timestamp: 1569898800000 index_price: 8431.97 prev_index_price: 8286.49 interest_8h: -3.544496169694662e-05 interest_1h: -3.815906848177951e-06 - timestamp: 1569902400000 index_price: 8422.36 prev_index_price: 8431.97 interest_8h: -1.404147515584998e-05 interest_1h: 8.312033064379086e-07 description: Response example description: Success response PublicTradesHistoryResponse: content: application/json: schema: $ref: '#/components/schemas/PublicTradesHistoryResponse' examples: response: value: jsonrpc: '2.0' id: 1469 result: trades: - trade_seq: 467 trade_id: '415305279' timestamp: 1770984454552 tick_direction: 2 price: 0.0525 mark_price: 0.05253883 iv: 45.91 instrument_name: BTC-24APR26-72000-C index_price: 66930.31 direction: buy amount: 3 contracts: 3 has_more: true description: Response example description: Success response PublicGetAnnouncementsResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetAnnouncementsResponse' examples: response: value: jsonrpc: '2.0' id: 3022 result: - title: Example announcement publication_timestamp: 1550058362418 important: false id: 1550058362418 body: Lorem ipsum dolor sit amet, consectetur adipiscing elit. description: Response example description: Success response PublicTestResponse: content: application/json: schema: $ref: '#/components/schemas/PublicTestResponse' examples: response: value: jsonrpc: '2.0' id: 8212 result: version: 1.2.26 description: Response example description: Success response PublicGetFundingRateValueResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetFundingRateValueResponse' examples: response: value: jsonrpc: '2.0' id: 7617 result: -0.00025056853702101664 description: Response example description: Success response PublicGetBlockRfqTradesResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetBlockRfqTradesResponse' examples: response: value: jsonrpc: '2.0' id: 1 result: continuation: 1739739009234:6570 block_rfqs: - id: 6611 timestamp: 1739803305362 combo_id: BTC-CS-28FEB25-100000_106000 legs: - price: 0.1 direction: buy instrument_name: BTC-28FEB25-100000-C ratio: 1 - price: 0.05 direction: sell instrument_name: BTC-28FEB25-106000-C ratio: 1 amount: 12.5 direction: sell mark_price: 0.010356754 trades: - price: 0.05 amount: 12.5 direction: sell hedge_amount: 50 hedge: price: 96000 amount: 50 direction: sell instrument_name: BTC-PERPETUAL index_prices: btc_usd: 96000 btc_usdc: 95950 - id: 6600 timestamp: 1739774397766 combo_id: BTC-CS-28FEB25-100000_106000 legs: - price: 0.1 direction: buy instrument_name: BTC-28FEB25-100000-C ratio: 1 - price: 0.05 direction: sell instrument_name: BTC-28FEB25-106000-C ratio: 1 amount: 12.5 direction: sell mark_price: 0.007458089 trades: - price: 0.05 amount: 12.5 direction: sell hedge_amount: 50 hedge: price: 96000 amount: 50 direction: sell instrument_name: BTC-PERPETUAL index_prices: btc_usd: 96000 btc_usdc: 95950 - id: 6579 timestamp: 1739743922308 combo_id: BTC-CS-17FEB25-89000_90000 legs: - price: 0.08 direction: buy instrument_name: BTC-17FEB25-89000-C ratio: 1 - price: 0.075 direction: sell instrument_name: BTC-17FEB25-90000-C ratio: 1 amount: 12.5 direction: sell mark_price: 0.010314468 trades: - price: 0.005 amount: 12.5 direction: sell description: Response example description: Success response PublicGetFundingChartDataResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetFundingChartDataResponse' description: Success response PublicGetIndexPriceNamesResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetIndexPriceNamesResponse' examples: response: value: jsonrpc: '2.0' id: 25718 result: - btc_eth - btc_usdc - eth_usdc description: Response example description: Success response PublicGetIndexChartDataResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetIndexChartDataResponse' examples: response: value: jsonrpc: '2.0' id: 1 result: - - 1573228800000 - 8751.7138636 - - 1573232400000 - 8751.7138636 - - 1573236000000 - 8751.7138636 - - 1573239600000 - 8751.7138636 - - 1573243200000 - 8751.7138636 description: Response example description: Success response PublicGetOrderBookResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetOrderBookResponse' examples: response: value: jsonrpc: '2.0' id: 8772 result: timestamp: 1550757626706 stats: volume: 93.35589552 price_change: 0.6913 low: 3940.75 high: 3976.25 state: open settlement_price: 3925.85 open_interest: 45.27600333464605 min_price: 3932.22 max_price: 3971.74 mark_price: 3931.97 last_price: 3955.75 instrument_name: BTC-PERPETUAL index_price: 3910.46 funding_8h: 0.00455263 current_funding: 0.00500063 change_id: 474988 bids: - - 3955.75 - 30 - - 3940.75 - 102020 - - 3423 - 42840 best_bid_price: 3955.75 best_bid_amount: 30 best_ask_price: 0 best_ask_amount: 0 asks: [] description: Response example description: Success response PublicGetVolatilityIndexDataResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetVolatilityIndexDataResponse' examples: response: value: jsonrpc: '2.0' id: 5 result: data: - - 1598019300000 - 0.210084879 - 0.212860821 - 0.210084879 - 0.212860821 - - 1598019360000 - 0.212869011 - 0.212987527 - 0.212869011 - 0.212987527 - - 1598019420000 - 0.212987723 - 0.212992597 - 0.212987723 - 0.212992597 continuation: null description: Response example description: Success response ErrorMessageResponse: content: application/json: schema: $ref: '#/components/schemas/ErrorMessageResponse' description: Success response Getunsubscribe200response: content: application/json: schema: $ref: '#/components/schemas/Getunsubscribe200response' examples: jsonObject: value: jsonrpc: '2.0' id: 3370 result: - deribit_price_index.btc_usd response: value: jsonrpc: '2.0' id: 3370 result: - deribit_price_index.btc_usd description: Response example description: Successfully unsubscribed from channels PublicGetInstrumentsResponse: content: application/json: schema: $ref: '#/components/schemas/PublicGetInstrumentsResponse' examples: response: value: jsonrpc: '2.0' id: 1 result: - tick_size: 2.5 tick_size_steps: [] taker_commission: 0.0005 settlement_period: month settlement_currency: BTC quote_currency: USD price_index: btc_usd min_trade_amount: 10 max_liquidation_commission: 0.0075 max_leverage: 50 maker_commission: 0 kind: future is_active: true instrument_name: BTC-29SEP23 instrument_id: 138583 instrument_type: reversed expiration_timestamp: 1695974400000 creation_timestamp: 1664524802000 counter_currency: USD contract_size: 10 block_trade_tick_size: 0.01 block_trade_min_trade_amount: 200000 block_trade_commission: 0.00025 base_currency: BTC state: open - tick_size: 0.5 tick_size_steps: [] taker_commission: 0.0005 settlement_period: perpetual settlement_currency: BTC quote_currency: USD price_index: btc_usd min_trade_amount: 10 max_liquidation_commission: 0.0075 max_leverage: 50 maker_commission: 0 kind: future is_active: true instrument_name: BTC-PERPETUAL instrument_id: 124972 instrument_type: reversed expiration_timestamp: 32503708800000 creation_timestamp: 1534167754000 counter_currency: USD contract_size: 10 block_trade_tick_size: 0.01 block_trade_min_trade_amount: 200000 block_trade_commission: 0.00025 base_currency: BTC state: open description: Response example description: Success response PublicTokenResponse: content: application/json: schema: $ref: '#/components/schemas/PublicTokenResponse' examples: response: value: jsonrpc: '2.0' id: 9929 result: access_token: 1582628593469.1MbQ-J_4.CBP-OqOwm_FBdMYj4cRK2dMXyHPfBtXGpzLxhWg31nHu3H_Q60FpE5_vqUBEQGSiMrIGzw3nC37NMb9d1tpBNqBOM_Ql9pXOmgtV9Yj3Pq1c6BqC6dU6eTxHMFO67x8GpJxqw_QcKP5IepwGBD-gfKSHfAv9AEnLJkNu3JkMJBdLToY1lrBnuedF3dU_uARm expires_in: 31536000 refresh_token: 1582628593469.1GP4rQd0.A9Wa78o5kFRIUP49mScaD1CqHgiK50HOl2VA6kCtWa8BQZU5Dr03BhcbXPNvEh3I_MVixKZXnyoBeKJwLl8LXnfo180ckAiPj3zOclcUu4zkXuF3NNP3sTPcDf1B3C1CwMKkJ1NOcf1yPmRbsrd7hbgQ-hLa40tfx6Oa-85ymm_3Z65LZcnCeLrqlj_A9jM scope: session:named_session mainaccount token_type: bearer description: Response example description: Success response