{
  "opencollection": "1.0.0",
  "info": {
    "name": "Deribit Account Management Block Trade API",
    "version": "2.1.1"
  },
  "items": [
    {
      "info": {
        "name": "Block Trade",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "GET /private/simulate_block_trade",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/private/simulate_block_trade",
            "params": [
              {
                "name": "role",
                "value": "",
                "type": "query",
                "description": "Describes if user wants to be maker or taker of trades"
              },
              {
                "name": "trades",
                "value": "",
                "type": "query",
                "description": "List of trades for block trade"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Checks if a block trade can be executed without actually executing it. Use this method to verify that a block trade will succeed before proceeding with the actual execution.\n\n**📖 Related Article:** [Block Trading](https://docs.deribit.com/articles/block-trading-api)\n\n**Scope:** `block_trade:read`\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fsimulate_block_trade)\n\n"
        },
        {
          "info": {
            "name": "GET /private/verify_block_trade",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/private/verify_block_trade",
            "params": [
              {
                "name": "timestamp",
                "value": "",
                "type": "query",
                "description": "Timestamp, shared with other party (milliseconds since the UNIX epoch)"
              },
              {
                "name": "nonce",
                "value": "",
                "type": "query",
                "description": "Nonce, shared with other party"
              },
              {
                "name": "role",
                "value": "",
                "type": "query",
                "description": "Describes if user wants to be maker or taker of trades"
              },
              {
                "name": "trades",
                "value": "",
                "type": "query",
                "description": "List of trades for block trade"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Verifies and creates a block trade signature. This is the first step in the block trade workflow - the first party calls this method to generate a signature that must be shared with the second party.\n\n**Note:** In the API, the `direction` field is always expressed from the maker's perspective. This means that when you accept a block trade as a taker, the direction shown in the API represents the opposite side of your trade. For example, if you are buying puts as a taker, the API will show the op"
        },
        {
          "info": {
            "name": "GET /private/execute_block_trade",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/private/execute_block_trade",
            "params": [
              {
                "name": "timestamp",
                "value": "",
                "type": "query",
                "description": "Timestamp, shared with other party (milliseconds since the UNIX epoch)"
              },
              {
                "name": "nonce",
                "value": "",
                "type": "query",
                "description": "Nonce, shared with other party"
              },
              {
                "name": "role",
                "value": "",
                "type": "query",
                "description": "Describes if user wants to be maker or taker of trades"
              },
              {
                "name": "trades",
                "value": "",
                "type": "query",
                "description": "List of trades for block trade"
              },
              {
                "name": "counterparty_signature",
                "value": "",
                "type": "query",
                "description": "Signature of block trade generated by `private/verify_block_trade_method`"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Executes a block trade. This is the second step in the block trade workflow - the second party calls this method with the signature received from the first party to execute the trade.\n\nThe whole request must be exactly the same as in [private/verify_block_trade](https://docs.deribit.com/api-reference/block-trade/private-verify_block_trade), only the `role` field should be set appropriately - this means that both sides have to agree on the same `timestamp`, `nonce`, and `trades` fields, and the s"
        },
        {
          "info": {
            "name": "GET /private/invalidate_block_trade_signature",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/private/invalidate_block_trade_signature",
            "params": [
              {
                "name": "signature",
                "value": "",
                "type": "query",
                "description": "Signature of block trade that will be invalidated"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Invalidates a block trade signature, effectively cancelling the block trade. This can be called at any time before [private/execute_block_trade](https://docs.deribit.com/api-reference/block-trade/private-execute_block_trade) is called.\n\n**📖 Related Article:** [Block Trading](https://docs.deribit.com/articles/block-trading-api)\n\n**Scope:** `block_trade:read_write`\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Finvalidate_block_trade_signature)\n\n"
        },
        {
          "info": {
            "name": "GET /private/get_block_trade",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/private/get_block_trade",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "query",
                "description": "Block trade id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Returns information about a specific block trade identified by `block_trade_id`.\n\n**📖 Related Article:** [Block Trading](https://docs.deribit.com/articles/block-trading-api)\n\n**Scope:** `block_trade:read`\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fget_block_trade)\n\n"
        },
        {
          "info": {
            "name": "GET /private/get_block_trades",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/private/get_block_trades",
            "params": [
              {
                "name": "currency",
                "value": "",
                "type": "query",
                "description": "The currency symbol"
              },
              {
                "name": "count",
                "value": "",
                "type": "query",
                "description": "Count of Block Trades returned, maximum - `101`"
              },
              {
                "name": "start_id",
                "value": "",
                "type": "query",
                "description": "Response will contain block trades older than the one provided in this field"
              },
              {
                "name": "end_id",
                "value": "",
                "type": "query",
                "description": "The id of the oldest block trade to be returned, `start_id` is required with `end_id`"
              },
              {
                "name": "block_rfq_id",
                "value": "",
                "type": "query",
                "description": "ID of the Block RFQ"
              },
              {
                "name": "broker_code",
                "value": "",
                "type": "query",
                "description": "Broker code to filter block trades. Only broker clients can use `broker_code` to filter broker block trades. Use `any` for all block trades."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Returns a list of the user's block trades. If currency is not provided, returns block trades for all currencies. `block_rfq_id` can be provided to receive block trades related to that particular Block RFQ.\n\n**📖 Related Article:** [Block Trading](https://docs.deribit.com/articles/block-trading-api)\n\n**Scope:** `block_trade:read`\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fget_block_trades)\n\n"
        },
        {
          "info": {
            "name": "GET /private/get_block_trade_requests",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/private/get_block_trade_requests",
            "params": [
              {
                "name": "broker_code",
                "value": "",
                "type": "query",
                "description": "Broker code to filter block trade requests. Only broker clients can use `broker_code` to query for their executed broker block trades."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Provides a list of block trade requests including pending approvals, declined trades, and expired trades. `timestamp` and `nonce` received in response can be used with [private/approve_block_trade](https://docs.deribit.com/api-reference/block-trade/private-approve_block_trade) or [private/reject_block_trade](https://docs.deribit.com/api-reference/block-trade/private-reject_block_trade) to approve or reject the pending block trade.\n\nTo use the block trade approval feature, an [additional API key "
        },
        {
          "info": {
            "name": "GET /private/approve_block_trade",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/private/approve_block_trade",
            "params": [
              {
                "name": "timestamp",
                "value": "",
                "type": "query",
                "description": "Timestamp, shared with other party (milliseconds since the UNIX epoch)"
              },
              {
                "name": "nonce",
                "value": "",
                "type": "query",
                "description": "Nonce, shared with other party"
              },
              {
                "name": "role",
                "value": "",
                "type": "query",
                "description": "Describes if user wants to be maker or taker of trades"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Approves a pending block trade. `nonce` and `timestamp` are used to identify the block trade while `role` should be opposite to the trading counterparty.\n\nUse [private/get_block_trade_requests](https://docs.deribit.com/api-reference/block-trade/private-get_block_trade_requests) to retrieve pending block trades that require approval.\n\nTo use the block trade approval feature, an [additional API key setting feature](https://docs.deribit.com/articles/creating-api-key#block-trade-approval-feature) ca"
        },
        {
          "info": {
            "name": "GET /private/reject_block_trade",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/private/reject_block_trade",
            "params": [
              {
                "name": "timestamp",
                "value": "",
                "type": "query",
                "description": "Timestamp, shared with other party (milliseconds since the UNIX epoch)"
              },
              {
                "name": "nonce",
                "value": "",
                "type": "query",
                "description": "Nonce, shared with other party"
              },
              {
                "name": "role",
                "value": "",
                "type": "query",
                "description": "Describes if user wants to be maker or taker of trades"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Rejects a pending block trade. `nonce` and `timestamp` are used to identify the block trade while `role` should be opposite to the trading counterparty.\n\nUse [private/get_block_trade_requests](https://docs.deribit.com/api-reference/block-trade/private-get_block_trade_requests) to retrieve pending block trades that require approval.\n\nTo use the block trade approval feature, an [additional API key setting feature](https://docs.deribit.com/articles/creating-api-key#block-trade-approval-feature) cal"
        },
        {
          "info": {
            "name": "GET /private/get_broker_trades",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/private/get_broker_trades",
            "params": [
              {
                "name": "currency",
                "value": "",
                "type": "query",
                "description": "The currency symbol"
              },
              {
                "name": "count",
                "value": "",
                "type": "query",
                "description": "Number of requested items, default - `20`, maximum - `1000`"
              },
              {
                "name": "start_id",
                "value": "",
                "type": "query",
                "description": "Response will contain block trades older than the one provided in this field"
              },
              {
                "name": "end_id",
                "value": "",
                "type": "query",
                "description": "The id of the oldest block trade to be returned, `start_id` is required with `end_id`"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**Broker Method** Returns list of broker block trades. If currency is not provided, returns broker block trades for all currencies.\n\n**Scope:** `block_trade:read`\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fget_broker_trades)\n\n"
        },
        {
          "info": {
            "name": "GET /private/get_broker_trade_requests",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://test.deribit.com/api/v2/private/get_broker_trade_requests",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**Broker Method** Provides a list of broker block trade requests including pending approvals, declined trades, and expired trades. `timestamp` and `nonce` received in response can be used to approve or reject the pending broker block trade. This method takes no parameters.\n\n**Scope:** `block_trade:read`\n\n[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fget_broker_trade_requests)\n\n"
        }
      ]
    }
  ],
  "bundled": true
}