swagger.yaml

---
swagger: "2.0"
info:
  description: |
    ## REST API for the BitMEX Trading Platform

    _If you are building automated tools, please subscribe to the_
    _[BitMEX API RSS Feed](https://blog.bitmex.com/api_announcement/feed/) for changes. The feed will be updated_
    _regularly and is the most reliable way to get downtime and update announcements._

    [View Changelog](/app/apiChangelog)

    -

    #### Getting Started

    Base URI: [https://www.bitmex.com/api/v1](/api/v1)

    ##### Fetching Data

    All REST endpoints are documented below. You can try out any query right from this interface.

    Most table queries accept `count`, `start`, and `reverse` params. Set `reverse=true` to get rows newest-first.

    Additional documentation regarding filters, timestamps, and authentication
    is available in [the main API documentation](/app/restAPI).

    _All_ table data is available via the [Websocket](/app/wsAPI). We highly recommend using the socket if you want
    to have the quickest possible data without being subject to ratelimits.

    ##### Return Types

    By default, all data is returned as JSON. Send `?_format=csv` to get CSV data or `?_format=xml` to get XML data.

    ##### Trade Data Queries

    _This is only a small subset of what is available, to get you started._

    Fill in the parameters and click the `Try it out!` button to try any of these queries.

    - [Pricing Data](#!/Quote/Quote_get)

    - [Trade Data](#!/Trade/Trade_get)

    - [OrderBook Data](#!/OrderBook/OrderBook_getL2)

    - [Settlement Data](#!/Settlement/Settlement_get)

    - [Exchange Statistics](#!/Stats/Stats_history)

    Every function of the BitMEX.com platform is exposed here and documented. Many more functions are available.

    ##### Swagger Specification

    [⇩ Download Swagger JSON](swagger.json)

    -

    ## All API Endpoints

    Click to expand a section.
  version: 1.2.0
  title: BitMEX API
  termsOfService: https://www.bitmex.com/app/terms
  contact:
    email: support@bitmex.com
host: www.bitmex.com
basePath: /api/v1
tags:
- name: Announcement
  description: Public Announcements
- name: APIKey
  description: Persistent API Keys for Developers
- name: Chat
  description: Trollbox Data
- name: Execution
  description: Raw Order and Balance Data
- name: Funding
  description: Swap Funding History
- name: Instrument
  description: "Tradeable Contracts, Indices, and History"
- name: Insurance
  description: Insurance Fund Data
- name: Leaderboard
  description: Information on Top Users
- name: Liquidation
  description: Active Liquidations
- name: GlobalNotification
  description: Account Notifications
- name: Order
  description: "Placement, Cancellation, Amending, and History"
- name: OrderBook
  description: Level 2 Book Data
- name: Position
  description: Summary of Open and Closed Positions
- name: Quote
  description: Best Bid/Offer Snapshots & Historical Bins
- name: Schema
  description: Dynamic Schemata for Developers
- name: Settlement
  description: Historical Settlement Data
- name: Stats
  description: Exchange Statistics
- name: Trade
  description: Individual & Bucketed Trades
- name: User
  description: Account Operations
- name: UserEvent
  description: User Events for Auditing
- name: Wallet
  description: Assets and Networks Data
- name: Address
- name: UserAffiliates
- name: Guild
- name: Porl
  description: Proof of Reserves/Liabilities
consumes:
- application/json
- application/x-www-form-urlencoded
produces:
- application/json
- application/xml
- text/xml
- application/javascript
- text/javascript
security:
- apiKey: []
  apiSignature: []
  apiExpires: []
paths:
  /announcement:
    get:
      tags:
      - Announcement
      summary: Get site announcements.
      operationId: Announcement.get
      parameters:
      - name: columns
        in: query
        description: "Array of column names to fetch. If omitted, will return all columns."
        required: false
        type: string
        format: JSON
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Announcement"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /announcement/urgent:
    get:
      tags:
      - Announcement
      summary: Get urgent (banner) announcements.
      operationId: Announcement.getUrgent
      parameters: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Announcement"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /apiKey:
    get:
      tags:
      - APIKey
      summary: Get your API Keys.
      operationId: APIKey.get
      parameters:
      - name: reverse
        in: query
        description: "If true, will sort results newest first."
        required: false
        type: boolean
        default: false
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/APIKey"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /chat/pinned:
    get:
      tags:
      - Chat
      summary: Get pinned message for a channel.
      operationId: Chat.getPinnedMessage
      parameters:
      - name: channelID
        in: query
        required: true
        type: number
        format: double
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/PinnedMessage"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /chat:
    get:
      tags:
      - Chat
      summary: Get chat messages.
      operationId: Chat.get
      parameters:
      - name: count
        in: query
        description: Number of results to fetch.
        required: false
        type: integer
        default: 100
        format: int32
      - name: start
        in: query
        description: Starting ID for results.
        required: false
        type: integer
        default: 0
        format: int32
      - name: reverse
        in: query
        description: "If true, will sort results newest first."
        required: false
        type: boolean
        default: true
      - name: channelID
        in: query
        description: Channel id. GET /chat/channels for ids. Global English by default
        required: false
        type: number
        default: 1.0
        format: double
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Chat"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
    post:
      tags:
      - Chat
      summary: Send a chat message.
      operationId: Chat.new
      parameters:
      - name: message
        in: formData
        required: true
        type: string
      - name: channelID
        in: formData
        description: Channel to post to. Default 1 (English).
        required: false
        type: number
        default: 1.0
        format: double
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/Chat"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /chat/channels:
    get:
      tags:
      - Chat
      summary: Get available channels.
      operationId: Chat.getChannels
      parameters: []
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/ChatChannel"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /chat/connected:
    get:
      tags:
      - Chat
      summary: Get connected users.
      description: Returns an array with browser users in the first position and API users (bots) in the second position.
      operationId: Chat.getConnected
      parameters: []
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/ConnectedUsers"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /execution:
    get:
      tags:
      - Execution
      summary: Get all raw executions for your account.
      description: |
        This returns all raw transactions, which includes order opening and cancelation, and order status
        changes. It can be quite noisy. More focused information is available at `/execution/tradeHistory`.

        You may also use the `filter` param to target your query. Specify an array as a filter value, such as
        `{"execType": ["Settlement", "Trade"]}` to filter on multiple values.

        See [the FIX Spec](http://www.onixs.biz/fix-dictionary/5.0.SP2/msgType_8_8.html) for explanations of these fields.
      operationId: Execution.get
      parameters:
      - name: symbol
        in: query
        description: |-
          Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series.

          You can also send a timeframe, e.g. `XBT:quarterly`. Timeframes are `nearest`, `daily`, `weekly`, `monthly`, `quarterly`, `biquarterly`, and `perpetual`.

          Symbols are case-insensitive.
        required: false
        type: string
      - name: filter
        in: query
        description: "Generic table filter. Send JSON key/value pairs, such as `{\"key\": \"value\"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https://www.bitmex.com/app/restAPI#Timestamp-Filters) for more details."
        required: false
        type: string
        format: JSON
      - name: columns
        in: query
        description: |-
          Array of column names to fetch. If omitted, will return all columns.

          Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
        required: false
        type: string
        format: JSON
      - name: count
        in: query
        description: Number of results to fetch. Must be a positive integer.
        required: false
        type: integer
        default: 100
        format: int32
      - name: start
        in: query
        description: Starting point for results.
        required: false
        type: integer
        default: 0
        format: int32
      - name: reverse
        in: query
        description: "If true, will sort results newest first."
        required: false
        type: boolean
        default: false
      - name: startTime
        in: query
        description: Starting date filter for results.
        required: false
        type: string
        format: date-time
      - name: endTime
        in: query
        description: Ending date filter for results.
        required: false
        type: string
        format: date-time
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Execution"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /execution/tradeHistory:
    get:
      tags:
      - Execution
      summary: Get all balance-affecting executions.
      operationId: Execution.getTradeHistory
      parameters:
      - name: targetAccountId
        in: query
        description: "AccountId fetching the trade history, must be a paired account with main user."
        required: false
        type: number
        format: double
      - name: targetAccountIds
        in: query
        description: "AccountIds fetching the trade history, must be a paired account with main user. Can be wildcard * to get all accounts linked to the authenticated user"
        required: false
        type: string
        format: JSON
      - name: symbol
        in: query
        description: |-
          Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series.

          You can also send a timeframe, e.g. `XBT:quarterly`. Timeframes are `nearest`, `daily`, `weekly`, `monthly`, `quarterly`, `biquarterly`, and `perpetual`.

          Symbols are case-insensitive.
        required: false
        type: string
      - name: filter
        in: query
        description: "Generic table filter. Send JSON key/value pairs, such as `{\"key\": \"value\"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https://www.bitmex.com/app/restAPI#Timestamp-Filters) for more details."
        required: false
        type: string
        format: JSON
      - name: columns
        in: query
        description: |-
          Array of column names to fetch. If omitted, will return all columns.

          Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
        required: false
        type: string
        format: JSON
      - name: count
        in: query
        description: Number of results to fetch. Must be a positive integer.
        required: false
        type: integer
        default: 100
        format: int32
      - name: start
        in: query
        description: Starting point for results.
        required: false
        type: integer
        default: 0
        format: int32
      - name: reverse
        in: query
        description: "If true, will sort results newest first."
        required: false
        type: boolean
        default: false
      - name: startTime
        in: query
        description: Starting date filter for results.
        required: false
        type: string
        format: date-time
      - name: endTime
        in: query
        description: Ending date filter for results.
        required: false
        type: string
        format: date-time
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Execution"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /funding:
    get:
      tags:
      - Funding
      summary: Get funding history.
      operationId: Funding.get
      parameters:
      - name: symbol
        in: query
        description: |-
          Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series.

          You can also send a timeframe, e.g. `XBT:quarterly`. Timeframes are `nearest`, `daily`, `weekly`, `monthly`, `quarterly`, `biquarterly`, and `perpetual`.

          Symbols are case-insensitive.
        required: false
        type: string
      - name: filter
        in: query
        description: "Generic table filter. Send JSON key/value pairs, such as `{\"key\": \"value\"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https://www.bitmex.com/app/restAPI#Timestamp-Filters) for more details."
        required: false
        type: string
        format: JSON
      - name: columns
        in: query
        description: |-
          Array of column names to fetch. If omitted, will return all columns.

          Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
        required: false
        type: string
        format: JSON
      - name: count
        in: query
        description: Number of results to fetch. Must be a positive integer.
        required: false
        type: integer
        default: 100
        format: int32
      - name: start
        in: query
        description: Starting point for results.
        required: false
        type: integer
        default: 0
        format: int32
      - name: reverse
        in: query
        description: "If true, will sort results newest first."
        required: false
        type: boolean
        default: false
      - name: startTime
        in: query
        description: Starting date filter for results.
        required: false
        type: string
        format: date-time
      - name: endTime
        in: query
        description: Ending date filter for results.
        required: false
        type: string
        format: date-time
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Funding"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /instrument:
    get:
      tags:
      - Instrument
      summary: Get instruments.
      description: |
        This returns all instruments and indices, including those that have settled or are unlisted.
        Use this endpoint if you want to query for individual instruments or use a complex filter.
        Use `/instrument/active` to return active instruments, or use a filter like `{"state": "Open"}`.

        The instrument type is specified by the `typ` param.

        - Perpetual Contracts - `FFWCSX`
        - Perpetual Contracts (FX underliers) - `FFWCSF`
        - Spot - `IFXXXP`
        - Futures - `FFCCSX`
        - BitMEX Basket Index - `MRBXXX`
        - BitMEX Crypto Index - `MRCXXX`
        - BitMEX FX Index - `MRFXXX`
        - BitMEX Lending/Premium Index - `MRRXXX`
        - BitMEX Volatility Index - `MRIXXX`
      operationId: Instrument.get
      parameters:
      - name: symbol
        in: query
        description: |-
          Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series.

          You can also send a timeframe, e.g. `XBT:quarterly`. Timeframes are `nearest`, `daily`, `weekly`, `monthly`, `quarterly`, `biquarterly`, and `perpetual`.

          Symbols are case-insensitive.
        required: false
        type: string
      - name: filter
        in: query
        description: "Generic table filter. Send JSON key/value pairs, such as `{\"key\": \"value\"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https://www.bitmex.com/app/restAPI#Timestamp-Filters) for more details."
        required: false
        type: string
        format: JSON
      - name: columns
        in: query
        description: |-
          Array of column names to fetch. If omitted, will return all columns.

          Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
        required: false
        type: string
        format: JSON
      - name: count
        in: query
        description: Number of results to fetch. Must be a positive integer.
        required: false
        type: integer
        default: 100
        format: int32
      - name: start
        in: query
        description: Starting point for results.
        required: false
        type: integer
        default: 0
        format: int32
      - name: reverse
        in: query
        description: "If true, will sort results newest first."
        required: false
        type: boolean
        default: false
      - name: startTime
        in: query
        description: Starting date filter for results.
        required: false
        type: string
        format: date-time
      - name: endTime
        in: query
        description: Ending date filter for results.
        required: false
        type: string
        format: date-time
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Instrument"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /instrument/active:
    get:
      tags:
      - Instrument
      summary: Get all active instruments and instruments that have expired in <24hrs.
      operationId: Instrument.getActive
      parameters: []
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Instrument"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /instrument/indices:
    get:
      tags:
      - Instrument
      summary: Get all price indices.
      operationId: Instrument.getIndices
      parameters: []
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Instrument"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /instrument/activeAndIndices:
    get:
      tags:
      - Instrument
      summary: Helper method. Gets all active instruments and all indices. This is a join of the result of /indices and /active.
      operationId: Instrument.getActiveAndIndices
      parameters: []
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Instrument"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /instrument/activeIntervals:
    get:
      tags:
      - Instrument
      summary: Return all active contract series and interval pairs.
      description: "This endpoint is useful for determining which pairs are live. It returns two arrays of   strings. The first is intervals, such as `[\"XBT:perpetual\", \"XBT:quarterly\", \"XBT:biquarterly\", \"ETH:quarterly\", ...]`. These identifiers are usable in any query's `symbol` param. The second array is the current resolution of these intervals. Results are mapped at the same index."
      operationId: Instrument.getActiveIntervals
      parameters: []
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/InstrumentInterval"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /instrument/compositeIndex:
    get:
      tags:
      - Instrument
      summary: Show constituent parts of an index.
      description: |
        Composite indices are built from multiple external price sources.

        Use this endpoint to get the underlying prices of an index. For example, send a `symbol` of `.BXBT` to
        get the ticks and weights of the constituent exchanges that build the ".BXBT" index.

        A tick with reference `"BMI"` and weight `null` is the composite index tick.
      operationId: Instrument.getCompositeIndex
      parameters:
      - name: symbol
        in: query
        description: The composite index symbol.
        required: false
        type: string
        default: .BXBT
      - name: filter
        in: query
        description: "Generic table filter. Send JSON key/value pairs, such as `{\"key\": \"value\"}`."
        required: false
        type: string
        format: JSON
      - name: columns
        in: query
        description: |-
          Array of column names to fetch. If omitted, will return all columns.

          Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
        required: false
        type: string
        format: JSON
      - name: count
        in: query
        description: Number of results to fetch. Must be a positive integer.
        required: false
        type: integer
        default: 100
        format: int32
      - name: start
        in: query
        description: Starting point for results.
        required: false
        type: integer
        default: 0
        format: int32
      - name: reverse
        in: query
        description: "If true, will sort results newest first."
        required: false
        type: boolean
        default: false
      - name: startTime
        in: query
        description: Starting date filter for results.
        required: false
        type: string
        format: date-time
      - name: endTime
        in: query
        description: Ending date filter for results.
        required: false
        type: string
        format: date-time
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/IndexComposite"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /instrument/usdVolume:
    get:
      tags:
      - Instrument
      summary: Get a summary of exchange statistics in USD.
      operationId: Instrument.getUsdVolume
      parameters:
      - name: symbol
        in: query
        description: Filter by symbol.
        required: false
        type: string
      - name: columns
        in: query
        description: Array of column names to fetch.
        required: false
        type: string
        format: JSON
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/StatsUSDBySymbol"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /insurance:
    get:
      tags:
      - Insurance
      summary: Get insurance fund history.
      operationId: Insurance.get
      parameters:
      - name: symbol
        in: query
        description: |-
          Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series.

          You can also send a timeframe, e.g. `XBT:quarterly`. Timeframes are `nearest`, `daily`, `weekly`, `monthly`, `quarterly`, `biquarterly`, and `perpetual`.

          Symbols are case-insensitive.
        required: false
        type: string
      - name: filter
        in: query
        description: "Generic table filter. Send JSON key/value pairs, such as `{\"key\": \"value\"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https://www.bitmex.com/app/restAPI#Timestamp-Filters) for more details."
        required: false
        type: string
        format: JSON
      - name: columns
        in: query
        description: |-
          Array of column names to fetch. If omitted, will return all columns.

          Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
        required: false
        type: string
        format: JSON
      - name: count
        in: query
        description: Number of results to fetch. Must be a positive integer.
        required: false
        type: integer
        default: 100
        format: int32
      - name: start
        in: query
        description: Starting point for results.
        required: false
        type: integer
        default: 0
        format: int32
      - name: reverse
        in: query
        description: "If true, will sort results newest first."
        required: false
        type: boolean
        default: false
      - name: startTime
        in: query
        description: Starting date filter for results.
        required: false
        type: string
        format: date-time
      - name: endTime
        in: query
        description: Ending date filter for results.
        required: false
        type: string
        format: date-time
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Insurance"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /leaderboard:
    get:
      tags:
      - Leaderboard
      summary: Get current leaderboard.
      operationId: Leaderboard.get
      parameters:
      - name: method
        in: query
        description: "Ranking type. Options: \"notional\", \"ROE\""
        required: false
        type: string
        default: notional
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Leaderboard"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /leaderboard/name:
    get:
      tags:
      - Leaderboard
      summary: Get your alias on the leaderboard.
      operationId: Leaderboard.getName
      parameters: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/inline_response_200"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /liquidation:
    get:
      tags:
      - Liquidation
      summary: Get liquidation orders.
      operationId: Liquidation.get
      parameters:
      - name: symbol
        in: query
        description: |-
          Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series.

          You can also send a timeframe, e.g. `XBT:quarterly`. Timeframes are `nearest`, `daily`, `weekly`, `monthly`, `quarterly`, `biquarterly`, and `perpetual`.

          Symbols are case-insensitive.
        required: false
        type: string
      - name: filter
        in: query
        description: "Generic table filter. Send JSON key/value pairs, such as `{\"key\": \"value\"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https://www.bitmex.com/app/restAPI#Timestamp-Filters) for more details."
        required: false
        type: string
        format: JSON
      - name: columns
        in: query
        description: |-
          Array of column names to fetch. If omitted, will return all columns.

          Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
        required: false
        type: string
        format: JSON
      - name: count
        in: query
        description: Number of results to fetch. Must be a positive integer.
        required: false
        type: integer
        default: 100
        format: int32
      - name: start
        in: query
        description: Starting point for results.
        required: false
        type: integer
        default: 0
        format: int32
      - name: reverse
        in: query
        description: "If true, will sort results newest first."
        required: false
        type: boolean
        default: false
      - name: startTime
        in: query
        description: Starting date filter for results.
        required: false
        type: string
        format: date-time
      - name: endTime
        in: query
        description: Ending date filter for results.
        required: false
        type: string
        format: date-time
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Liquidation"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /globalNotification:
    get:
      tags:
      - GlobalNotification
      summary: Get your current GlobalNotifications.
      description: This is an upcoming feature and currently does not return data.
      operationId: GlobalNotification.get
      parameters: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/GlobalNotification"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /order:
    get:
      tags:
      - Order
      summary: Get your orders.
      description: |-
        To get open orders only, send {"open": true} in the filter param.

        See <a href="http://www.onixs.biz/fix-dictionary/5.0.SP2/msgType_D_68.html">the FIX Spec</a> for explanations of these fields.
      operationId: Order.getOrders
      parameters:
      - name: symbol
        in: query
        description: |-
          Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series.

          You can also send a timeframe, e.g. `XBT:quarterly`. Timeframes are `nearest`, `daily`, `weekly`, `monthly`, `quarterly`, `biquarterly`, and `perpetual`.

          Symbols are case-insensitive.
        required: false
        type: string
      - name: filter
        in: query
        description: "Generic table filter. Send JSON key/value pairs, such as `{\"key\": \"value\"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https://www.bitmex.com/app/restAPI#Timestamp-Filters) for more details."
        required: false
        type: string
        format: JSON
      - name: columns
        in: query
        description: |-
          Array of column names to fetch. If omitted, will return all columns.

          Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
        required: false
        type: string
        format: JSON
      - name: count
        in: query
        description: Number of results to fetch. Must be a positive integer.
        required: false
        type: integer
        default: 100
        format: int32
      - name: start
        in: query
        description: Starting point for results.
        required: false
        type: integer
        default: 0
        format: int32
      - name: reverse
        in: query
        description: "If true, will sort results newest first."
        required: false
        type: boolean
        default: false
      - name: startTime
        in: query
        description: Starting date filter for results.
        required: false
        type: string
        format: date-time
      - name: endTime
        in: query
        description: Ending date filter for results.
        required: false
        type: string
        format: date-time
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Order"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
    post:
      tags:
      - Order
      summary: Create a new order.
      description: |
        ## Placing Orders

        This endpoint is used for placing orders. See individual fields below for more details on their use.

        #### Order Types

        All orders require a `symbol`. All other fields are optional except when otherwise specified.

        These are the valid `ordType`s:

        - **Limit**: The default order type. Specify an `orderQty` and `price`.
        - **Market**: A traditional Market order. A Market order will execute until filled or your bankruptcy price is reached, at
          which point it will cancel.
        - **Stop**: A Stop Market order. Specify an `orderQty` and `stopPx`. When the `stopPx` is reached, the order will be entered
          into the book.
          - On sell orders, the order will trigger if the triggering price is lower than the `stopPx`. On buys, higher.
          - Note: Stop orders do not consume margin until triggered. Be sure that the required margin is available in your
            account so that it may trigger fully.
          - `Close` Stops don't require an `orderQty`. See Execution Instructions below.
        - **StopLimit**: Like a Stop Market, but enters a Limit order instead of a Market order. Specify an `orderQty`, `stopPx`,
          and `price`.
        - **MarketIfTouched**: Similar to a Stop, but triggers are done in the opposite direction. Useful for Take Profit orders.
        - **LimitIfTouched**: As above; use for Take Profit Limit orders.
        - **Pegged**: Pegged orders allow users to submit a limit price relative to the current market price. Specify a
          `pegPriceType`, and `pegOffsetValue`.
          - Pegged orders **must** have an `execInst` of `Fixed`. This means the limit price is set at the time the order
            is accepted and does not change as the reference price changes.
          - `PrimaryPeg`: Price is set relative to near touch price.
          - `MarketPeg`: Price is set relative to far touch price.
          - A `pegPriceType` submitted with no `ordType` is treated as a `Pegged` order.

        #### Execution Instructions

        The following `execInst`s are supported. If using multiple, separate with a comma (e.g. `LastPrice,Close`).

        - **ParticipateDoNotInitiate**: Also known as a Post-Only order. If this order would have executed on placement, it will cancel instead.
          This is intended to protect you from the far touch moving towards you while the order is in transit.
          It is not intended for speculating on the far touch moving away after submission - we consider such behaviour abusive and monitor for it.
        - **MarkPrice, LastPrice, IndexPrice**: Used by stop and if-touched orders to determine the triggering price.
          Use only one. By default, `MarkPrice` is used. Also used for Pegged orders to define the value of `LastPeg`. IndexPrice is not applicable to spot trading symbols.
        - **ReduceOnly**: A `ReduceOnly` order can only reduce your position, not increase it. If you have a `ReduceOnly`
          limit order that rests in the order book while the position is reduced by other orders, then its order quantity will
          be amended down or canceled. If there are multiple `ReduceOnly` orders the least aggressive will be amended first. Not applicable to spot trading symbols.
        - **Close**: `Close` implies `ReduceOnly`. A `Close` order will cancel other active limit orders with the same side
          and symbol if the open quantity exceeds the current position. This is useful for stops: by canceling these orders, a
          `Close` Stop is ensured to have the margin required to execute, and can only execute up to the full size of your
          position. If `orderQty` is not specified, a `Close` order has an `orderQty` equal to your current position's size. Not applicable to spot trading symbols.
          - Note that a `Close` order without an `orderQty` requires a `side`, so that BitMEX knows if it should trigger
            above or below the `stopPx`.
        - **LastWithinMark**: Used by stop orders with `LastPrice` to allow stop triggers only when:
          - For Sell Stop Market / Stop Limit Order
            - Last Price &lt= Stop Price
            - Last Price &gt= Mark Price × (1 - 5%)
          - For Buy Stop Market / Stop Limit Order:
            - Last Price &gt= Stop Price
            - Last Price &lt= Mark Price × (1 + 5%)
          - Not applicable to spot trading symbols.
        - **Fixed**: Pegged orders **must** have an `execInst` of `Fixed`. This means the limit price is set at the time
          the order is accepted and does not change as the reference price changes.

        #### Pegged Orders

        Pegged orders allow users to submit a limit price relative to the current market price.
        The limit price is set once when the order is submitted and does not change with the reference price.
        This order type is not intended for speculating on the far touch moving away after submission - we consider such behaviour abusive and monitor for it.

        Pegged orders have an `ordType` of `Pegged`, and an `execInst` of `Fixed`.

        A `pegPriceType` and `pegOffsetValue` must also be submitted:

        - `PrimaryPeg` - price is set relative to the **near touch** price
        - `MarketPeg` - price is set relative to the **far touch** price

        #### Trailing Stop Pegged Orders

        Use `pegPriceType` of `TrailingStopPeg` to create Trailing Stops.

        The price is set at submission and updates once per second if the underlying price (last/mark/index) has moved by
        more than 0.1%. `stopPx` then moves as the market moves away from the peg, and freezes as the market moves toward it.

        Use `pegOffsetValue` to set the `stopPx` of your order. The peg is set to the triggering price specified in the
        `execInst` (default `MarkPrice`). Use a negative offset for stop-sell and buy-if-touched orders.

        Requires `ordType`: `Stop`, `StopLimit`, `MarketIfTouched`, `LimitIfTouched`.

        #### Linked Orders

        Linked Orders are an advanced capability. It is very powerful, but its use requires careful coding and testing.
        Please follow this document carefully and use the [Testnet Exchange](https://testnet.bitmex.com) while developing.

        BitMEX offers four advanced Linked Order types:

        - **OCO**: _One Cancels the Other_. A very flexible version of the standard Stop / Take Profit technique.
          Multiple orders may be linked together using a single `clOrdLinkID`. Send a `contingencyType` of
          `OneCancelsTheOther` on the orders. The first order that fully or partially executes (or activates
          for `Stop` orders) will cancel all other orders with the same `clOrdLinkID`.
        - **OTO**: _One Triggers the Other_. Send a `contingencyType` of `'OneTriggersTheOther'` on the primary order and
          then subsequent orders with the same `clOrdLinkID` will be not be triggered until the primary order fully executes.

        #### Trailing Stops

        You may use `pegPriceType` of `'TrailingStopPeg'` to create Trailing Stops. The pegged `stopPx` will move as the market
        moves away from the peg, and freeze as the market moves toward it.

        To use, combine with `pegOffsetValue` to set the `stopPx` of your order. The peg is set to the triggering price
        specified in the `execInst` (default `'MarkPrice'`). Use a negative offset for stop-sell and buy-if-touched orders.

        Requires `ordType`: `'Stop', 'StopLimit', 'MarketIfTouched', 'LimitIfTouched'`.

        #### Simple Quantities

        [Simple Quantities are deprecated as of 2018/10/26](https://blog.bitmex.com/api_announcement/deprecation-of-simpleorderqty-functionality/)

        #### Rate Limits

        You can improve your reactivity to market movements while staying under your rate limit by using the
        [Amend](#!/Order/Order_amend) endpoint (PUT /order). This allows you to stay
        in the market and avoids the cancel/replace cycle.

        #### Tracking Your Orders

        If you want to keep track of order IDs yourself, set a unique `clOrdID` per order.
        This `clOrdID` will come back as a property on the order and any related executions (including on the WebSocket),
        and can be used to get or cancel the order. Max length is 36 characters.

        You can also change the `clOrdID` by amending an order, supplying an `origClOrdID`, and your desired new
        ID as the `clOrdID` param, like so:

        ```
        # Amends an order's leavesQty, and updates its clOrdID to "def-456"
        PUT /api/v1/order {"origClOrdID": "abc-123", "clOrdID": "def-456", "leavesQty": 1000}
        ```
      operationId: Order.new
      parameters:
      - name: symbol
        in: formData
        description: Instrument symbol. e.g. 'XBTUSD'.
        required: true
        type: string
      - name: side
        in: formData
        description: "Order side. Valid options: Buy, Sell. Defaults to 'Buy' unless `orderQty` is negative."
        required: false
        type: string
      - name: simpleOrderQty
        in: formData
        description: "Deprecated: simple orders are not supported after 2018/10/26"
        required: false
        type: number
        format: double
      - name: orderQty
        in: formData
        description: "Order quantity in units of the instrument (i.e. contracts, for spot it is base currency in minor currency for spot (e.g. XBt quantity for XBT))."
        required: false
        type: integer
        format: int32
      - name: price
        in: formData
        description: "Optional limit price for 'Limit', 'StopLimit', and 'LimitIfTouched' orders."
        required: false
        type: number
        format: double
      - name: displayQty
        in: formData
        description: Optional quantity to display in the book. Use 0 for a fully hidden order.
        required: false
        type: integer
        format: int32
      - name: stopPx
        in: formData
        description: "Optional trigger price for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders. Use a price below the current price for stop-sell orders and buy-if-touched orders. Use `execInst` of 'MarkPrice' or 'LastPrice' to define the current price used for triggering."
        required: false
        type: number
        format: double
      - name: clOrdID
        in: formData
        description: Optional Client Order ID. This clOrdID will come back on the order and any related executions.
        required: false
        type: string
      - name: clOrdLinkID
        in: formData
        description: Optional Client Order Link ID for contingent orders
        required: false
        type: string
      - name: pegOffsetValue
        in: formData
        description: "Optional trailing offset from the current price for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders; use a negative offset for stop-sell orders and buy-if-touched orders. Optional offset from the peg price for 'Pegged' orders."
        required: false
        type: number
        format: double
      - name: pegPriceType
        in: formData
        description: "Optional peg price type. Valid options: MarketPeg, PrimaryPeg, TrailingStopPeg."
        required: false
        type: string
      - name: ordType
        in: formData
        description: "Order type. Valid options: Market, Limit, Stop, StopLimit, MarketIfTouched, LimitIfTouched, Pegged. Defaults to 'Limit' when `price` is specified. Defaults to 'Stop' when `stopPx` is specified. Defaults to 'StopLimit' when `price` and `stopPx` are specified."
        required: false
        type: string
        default: Limit
      - name: timeInForce
        in: formData
        description: "Time in force. Valid options: Day, GoodTillCancel, ImmediateOrCancel, FillOrKill. Defaults to 'GoodTillCancel' for 'Limit', 'StopLimit', and 'LimitIfTouched' orders."
        required: false
        type: string
      - name: execInst
        in: formData
        description: "Optional execution instructions. Valid options: ParticipateDoNotInitiate, AllOrNone, MarkPrice, IndexPrice, LastPrice, Close, ReduceOnly, Fixed, LastWithinMark. 'AllOrNone' instruction requires `displayQty` to be 0. 'MarkPrice', 'IndexPrice' or 'LastPrice' instruction valid for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders. 'LastWithinMark' instruction valid for 'Stop' and 'StopLimit' with instruction 'LastPrice'. IndexPrice, LastWithMark, Close and ReduceOnly are not applicable to spot trading symbols."
        required: false
        type: string
      - name: contingencyType
        in: formData
        description: "Optional contingency type for use with `clOrdLinkID`. Valid options: OneCancelsTheOther, OneTriggersTheOther."
        required: false
        type: string
      - name: text
        in: formData
        description: Optional order annotation. e.g. 'Take profit'.
        required: false
        type: string
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/Order"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
    put:
      tags:
      - Order
      summary: Amend the quantity or price of an open order.
      description: |
        Send an `orderID` or `origClOrdID` to identify the order you wish to amend.

        Both order quantity and price can be amended. Only one `qty` field can be used to amend.

        Use the `leavesQty` field to specify how much of the order you wish to remain open. This can be useful
        if you want to adjust your position's delta by a certain amount, regardless of how much of the order has
        already filled.

        > A `leavesQty` can be used to make a "Filled" order live again, if it is received within 60 seconds of the fill.
      operationId: Order.amend
      parameters:
      - name: orderID
        in: formData
        description: Order ID
        required: false
        type: string
      - name: origClOrdID
        in: formData
        description: Client Order ID. See POST /order.
        required: false
        type: string
      - name: clOrdID
        in: formData
        description: "Optional new Client Order ID, requires `origClOrdID`."
        required: false
        type: string
      - name: simpleOrderQty
        in: formData
        description: "Deprecated: simple orders are not supported after 2018/10/26"
        required: false
        type: number
        format: double
      - name: orderQty
        in: formData
        description: "Optional order quantity in units of the instrument (i.e. contracts, for spot it is the base currency in minor currency (e.g. XBt quantity for XBT))."
        required: false
        type: integer
        format: int32
      - name: simpleLeavesQty
        in: formData
        description: "Deprecated: simple orders are not supported after 2018/10/26"
        required: false
        type: number
        format: double
      - name: leavesQty
        in: formData
        description: "Optional leaves quantity in units of the instrument (i.e. contracts, for spot it is the base currency in minor currency (e.g. XBt quantity for XBT)). Useful for amending partially filled orders."
        required: false
        type: integer
        format: int32
      - name: price
        in: formData
        description: "Optional limit price for 'Limit', 'StopLimit', and 'LimitIfTouched' orders."
        required: false
        type: number
        format: double
      - name: stopPx
        in: formData
        description: "Optional trigger price for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders. Use a price below the current price for stop-sell orders and buy-if-touched orders."
        required: false
        type: number
        format: double
      - name: pegOffsetValue
        in: formData
        description: "Optional trailing offset from the current price for 'Stop', 'StopLimit', 'MarketIfTouched', and 'LimitIfTouched' orders; use a negative offset for stop-sell orders and buy-if-touched orders. Optional offset from the peg price for 'Pegged' orders."
        required: false
        type: number
        format: double
      - name: text
        in: formData
        description: Optional amend annotation. e.g. 'Adjust skew'.
        required: false
        type: string
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/Order"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
    delete:
      tags:
      - Order
      summary: Cancel order(s). Send multiple order IDs to cancel in bulk.
      description: Either an orderID or a clOrdID must be provided.
      operationId: Order.cancel
      parameters:
      - name: orderID
        in: formData
        description: Order ID(s).
        required: false
        type: string
        format: JSON
      - name: clOrdID
        in: formData
        description: Client Order ID(s). See POST /order.
        required: false
        type: string
        format: JSON
      - name: text
        in: formData
        description: Optional cancellation annotation. e.g. 'Spread Exceeded'.
        required: false
        type: string
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Order"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /order/closePosition:
    post:
      tags:
      - Order
      summary: "Close a position. [Deprecated, use POST /order with execInst: 'Close']"
      description: "If no `price` is specified, a market order will be submitted to close the whole of your position. This will also close all other open orders in this symbol."
      operationId: Order.closePosition
      parameters:
      - name: symbol
        in: formData
        description: Symbol of position to close.
        required: true
        type: string
      - name: price
        in: formData
        description: Optional limit price.
        required: false
        type: number
        format: double
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/Order"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /order/all:
    delete:
      tags:
      - Order
      summary: Cancels all of your orders.
      operationId: Order.cancelAll
      parameters:
      - name: targetAccountIds
        in: formData
        description: "AccountIds to cancel all orders, must be a paired account with main user. Also accepts wildcard, [*], this will cancel all orders for all accounts. the authenticated user has order write permissions for."
        required: false
        type: string
        format: JSON
      - name: symbol
        in: formData
        description: "Optional symbol. If provided, only cancels orders for that symbol."
        required: false
        type: string
      - name: filter
        in: formData
        description: "Optional filter for cancellation. Use to only cancel some orders, e.g. `{\"side\": \"Buy\"}`."
        required: false
        type: string
        format: JSON
      - name: text
        in: formData
        description: Optional cancellation annotation. e.g. 'Spread Exceeded'
        required: false
        type: string
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Order"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /order/cancelAllAfter:
    post:
      tags:
      - Order
      summary: Automatically cancel all your orders after a specified timeout.
      description: |
        Useful as a dead-man's switch to ensure your orders are canceled in case of an outage.
        If called repeatedly, the existing offset will be canceled and a new one will be inserted in its place.

        Example usage: call this route at 15s intervals with an offset of 60000 (60s).
        If this route is not called within 60 seconds, all your orders will be automatically canceled.

        This is also available via [WebSocket](https://www.bitmex.com/app/wsAPI#Dead-Mans-Switch-Auto-Cancel).
      operationId: Order.cancelAllAfter
      parameters:
      - name: timeout
        in: formData
        description: 'Timeout in ms. Set to 0 to cancel this timer. '
        required: true
        type: number
        format: double
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: object
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /orderBook/L2:
    get:
      tags:
      - OrderBook
      summary: Get current orderbook in vertical format.
      operationId: OrderBook.getL2
      parameters:
      - name: symbol
        in: query
        description: Instrument symbol. Send a series (e.g. XBT) to get data for the nearest contract in that series.
        required: true
        type: string
      - name: depth
        in: query
        description: Orderbook depth per side. Send 0 for full depth.
        required: false
        type: integer
        default: 25
        minimum: 0
        format: int32
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/OrderBookL2"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /position:
    get:
      tags:
      - Position
      summary: Get your positions.
      description: |
        This endpoint is used for retrieving position information. The fields largely follow the [FIX spec](http://www.onixs.biz/fix-dictionary/5.0.SP2/msgType_AP_6580.html) definitions. Some selected fields are explained in more detail below.

        The fields _account_, _symbol_, _currency_ are unique to each position and form its key.

        Spot trading symbols returns a subset of the position fields, mainly the open order aggregates.

        - **account**: Your unique account ID.
        - **symbol**: The contract for this position.
        - **currency**: The margin currency for this position.
        - **underlying**: Meta data of the _symbol_.
        - **quoteCurrency**: Meta data of the _symbol_, All prices are in the _quoteCurrency_
        - **commission**: The maximum of the maker, taker, and settlement fee.
        - **initMarginReq**: The initial margin requirement. This will be at least the symbol's default initial maintenance margin, but can be higher if you choose lower leverage.
        - **maintMarginReq**: The maintenance margin requirement. This will be at least the symbol's default maintenance maintenance margin, but can be higher if you choose a higher risk limit.
        - **riskLimit**: This is a function of your _maintMarginReq_.
        - **leverage**: 1 / initMarginReq.
        - **crossMargin**: True/false depending on whether you set cross margin on this position.
        - **deleveragePercentile**: Indicates where your position is in the ADL queue.
        - **rebalancedPnl**: The value of realised PNL that has transferred to your wallet for this position.
        - **prevRealisedPnl**: The value of realised PNL that has transferred to your wallet for this position since the position was closed.
        - **currentQty**: The current position amount in contracts.
        - **currentCost**: The current cost of the position in the settlement currency of the symbol (_currency_).
        - **currentComm**: The current commission of the position in the settlement currency of the symbol (_currency_).
        - **realisedCost**: The realised cost of this position calculated with regard to average cost accounting.
        - **unrealisedCost**: _currentCost_ - _realisedCost_.
        - **grossOpenPremium**: The amount your bidding above the mark price in the settlement currency of the symbol (_currency_).
        - **markPrice**: The mark price of the symbol in _quoteCurrency_.
        - **markValue**: The _currentQty_ at the mark price in the settlement currency of the symbol (_currency_).
        - **homeNotional**: Value of position in units of _underlying_.
        - **foreignNotional**: Value of position in units of _quoteCurrency_.
        - **realisedPnl**: The negative of _realisedCost_.
        - **unrealisedPnl**: _unrealisedGrossPnl_.
        - **liquidationPrice**: Once markPrice reaches this price, this position will be liquidated.
        - **bankruptPrice**: Once markPrice reaches this price, this position will have no equity.
      operationId: Position.get
      parameters:
      - name: filter
        in: query
        description: "Table filter. For example, send {\"symbol\": \"XBTUSD\"}."
        required: false
        type: string
        format: JSON
      - name: columns
        in: query
        description: "Which columns to fetch. For example, send [\"columnName\"]."
        required: false
        type: string
        format: JSON
      - name: count
        in: query
        description: Number of rows to fetch.
        required: false
        type: integer
        format: int32
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Position"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /position/isolate:
    post:
      tags:
      - Position
      summary: Enable isolated margin or cross margin per-position.
      description: Users can switch isolate margin per-position. This function allows switching margin isolation (aka fixed margin) on and off.
      operationId: Position.isolateMargin
      parameters:
      - name: symbol
        in: formData
        description: Position symbol to isolate.
        required: true
        type: string
      - name: enabled
        in: formData
        description: "True for isolated margin, false for cross margin."
        required: false
        type: boolean
        default: true
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/Position"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /position/riskLimit:
    post:
      tags:
      - Position
      summary: Update your risk limit.
      description: Risk Limits limit the size of positions you can trade at various margin levels. Larger positions require more margin. Please see the Risk Limit documentation for more details.
      operationId: Position.updateRiskLimit
      parameters:
      - name: symbol
        in: formData
        description: Symbol of position to update risk limit on.
        required: true
        type: string
      - name: riskLimit
        in: formData
        description: "New Risk Limit, in Satoshis."
        required: true
        type: integer
        format: int64
      - name: targetAccountId
        in: formData
        description: "AccountId for the position that the risk limit would be updated on, must be a paired account with main user."
        required: false
        type: number
        format: double
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/Position"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /position/transferMargin:
    post:
      tags:
      - Position
      summary: Transfer equity in or out of a position.
      description: "When margin is isolated on a position, use this function to add or remove margin from the position. Note that you cannot remove margin below the initial margin threshold."
      operationId: Position.transferIsolatedMargin
      parameters:
      - name: symbol
        in: formData
        description: Symbol of position to isolate.
        required: true
        type: string
      - name: amount
        in: formData
        description: "Amount to transfer, in Satoshis. May be negative."
        required: true
        type: integer
        format: int64
      - name: targetAccountId
        in: formData
        description: "AccountId for the position that the margin would be transfered to, must be a paired account with main user."
        required: false
        type: number
        format: double
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/Position"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /position/leverage:
    post:
      tags:
      - Position
      summary: Choose leverage for a position.
      description: Users can choose an isolated leverage. This will automatically enable isolated margin.
      operationId: Position.updateLeverage
      parameters:
      - name: symbol
        in: formData
        description: Symbol of position to adjust.
        required: true
        type: string
      - name: leverage
        in: formData
        description: Leverage value. Send a number between 0.01 and 100 to enable isolated margin with a fixed leverage. Send 0 to enable cross margin.
        required: true
        type: number
        format: double
      - name: targetAccountId
        in: formData
        description: "AccountId for the position that the leverage would be changed on, must be a paired account with main user."
        required: false
        type: number
        format: double
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/Position"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /quote:
    get:
      tags:
      - Quote
      summary: Get Quotes.
      operationId: Quote.get
      parameters:
      - name: symbol
        in: query
        description: |-
          Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series.

          You can also send a timeframe, e.g. `XBT:quarterly`. Timeframes are `nearest`, `daily`, `weekly`, `monthly`, `quarterly`, `biquarterly`, and `perpetual`.

          Symbols are case-insensitive.
        required: false
        type: string
      - name: filter
        in: query
        description: "Generic table filter. Send JSON key/value pairs, such as `{\"key\": \"value\"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https://www.bitmex.com/app/restAPI#Timestamp-Filters) for more details."
        required: false
        type: string
        format: JSON
      - name: columns
        in: query
        description: |-
          Array of column names to fetch. If omitted, will return all columns.

          Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
        required: false
        type: string
        format: JSON
      - name: count
        in: query
        description: Number of results to fetch. Must be a positive integer.
        required: false
        type: integer
        default: 100
        format: int32
      - name: start
        in: query
        description: Starting point for results.
        required: false
        type: integer
        default: 0
        format: int32
      - name: reverse
        in: query
        description: "If true, will sort results newest first."
        required: false
        type: boolean
        default: false
      - name: startTime
        in: query
        description: Starting date filter for results.
        required: false
        type: string
        format: date-time
      - name: endTime
        in: query
        description: Ending date filter for results.
        required: false
        type: string
        format: date-time
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Quote"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /quote/bucketed:
    get:
      tags:
      - Quote
      summary: Get previous quotes in time buckets.
      description: "Timestamps returned by our bucketed endpoints are the **end** of the period, indicating when the bucket was written to disk. Some other common systems use the timestamp as the beginning of the period. Please be aware of this when using this endpoint."
      operationId: Quote.getBucketed
      parameters:
      - name: binSize
        in: query
        description: "Time interval to bucket by. Available options: [1m,5m,1h,1d]."
        required: false
        type: string
        default: 1m
      - name: partial
        in: query
        description: "If true, will send in-progress (incomplete) bins for the current time period."
        required: false
        type: boolean
        default: false
      - name: symbol
        in: query
        description: |-
          Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series.

          You can also send a timeframe, e.g. `XBT:quarterly`. Timeframes are `nearest`, `daily`, `weekly`, `monthly`, `quarterly`, `biquarterly`, and `perpetual`.

          Symbols are case-insensitive.
        required: false
        type: string
      - name: filter
        in: query
        description: "Generic table filter. Send JSON key/value pairs, such as `{\"key\": \"value\"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https://www.bitmex.com/app/restAPI#Timestamp-Filters) for more details."
        required: false
        type: string
        format: JSON
      - name: columns
        in: query
        description: |-
          Array of column names to fetch. If omitted, will return all columns.

          Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
        required: false
        type: string
        format: JSON
      - name: count
        in: query
        description: Number of results to fetch. Must be a positive integer.
        required: false
        type: integer
        default: 100
        format: int32
      - name: start
        in: query
        description: Starting point for results.
        required: false
        type: integer
        default: 0
        format: int32
      - name: reverse
        in: query
        description: "If true, will sort results newest first."
        required: false
        type: boolean
        default: false
      - name: startTime
        in: query
        description: Starting date filter for results.
        required: false
        type: string
        format: date-time
      - name: endTime
        in: query
        description: Ending date filter for results.
        required: false
        type: string
        format: date-time
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Quote"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /schema:
    get:
      tags:
      - Schema
      summary: Get model schemata for data objects returned by this API.
      operationId: Schema.get
      parameters:
      - name: model
        in: query
        description: "Optional model filter. If omitted, will return all models."
        required: false
        type: string
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: object
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /schema/websocketHelp:
    get:
      tags:
      - Schema
      summary: Returns help text & subject list for websocket usage.
      operationId: Schema.websocketHelp
      parameters: []
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: object
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /settlement:
    get:
      tags:
      - Settlement
      summary: Get settlement history.
      operationId: Settlement.get
      parameters:
      - name: symbol
        in: query
        description: |-
          Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series.

          You can also send a timeframe, e.g. `XBT:quarterly`. Timeframes are `nearest`, `daily`, `weekly`, `monthly`, `quarterly`, `biquarterly`, and `perpetual`.

          Symbols are case-insensitive.
        required: false
        type: string
      - name: filter
        in: query
        description: "Generic table filter. Send JSON key/value pairs, such as `{\"key\": \"value\"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https://www.bitmex.com/app/restAPI#Timestamp-Filters) for more details."
        required: false
        type: string
        format: JSON
      - name: columns
        in: query
        description: |-
          Array of column names to fetch. If omitted, will return all columns.

          Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
        required: false
        type: string
        format: JSON
      - name: count
        in: query
        description: Number of results to fetch. Must be a positive integer.
        required: false
        type: integer
        default: 100
        format: int32
      - name: start
        in: query
        description: Starting point for results.
        required: false
        type: integer
        default: 0
        format: int32
      - name: reverse
        in: query
        description: "If true, will sort results newest first."
        required: false
        type: boolean
        default: false
      - name: startTime
        in: query
        description: Starting date filter for results.
        required: false
        type: string
        format: date-time
      - name: endTime
        in: query
        description: Ending date filter for results.
        required: false
        type: string
        format: date-time
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Settlement"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /stats:
    get:
      tags:
      - Stats
      summary: Get exchange-wide and per-series turnover and volume statistics.
      operationId: Stats.get
      parameters: []
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Stats"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /stats/history:
    get:
      tags:
      - Stats
      summary: Get historical exchange-wide and per-series turnover and volume statistics.
      operationId: Stats.history
      parameters: []
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/StatsHistory"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /stats/historyUSD:
    get:
      tags:
      - Stats
      summary: Get a summary of exchange statistics in USD.
      operationId: Stats.historyUSD
      parameters: []
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/StatsUSD"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /trade:
    get:
      tags:
      - Trade
      summary: Get Trades.
      description: |-
        Please note that indices (symbols starting with `.`) post trades at intervals to the trade feed. These have a `size` of 0 and are used only to indicate a changing price.

        See [the FIX Spec](http://www.onixs.biz/fix-dictionary/5.0.SP2/msgType_AE_6569.html) for explanations of these fields.
      operationId: Trade.get
      parameters:
      - name: symbol
        in: query
        description: |-
          Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series.

          You can also send a timeframe, e.g. `XBT:quarterly`. Timeframes are `nearest`, `daily`, `weekly`, `monthly`, `quarterly`, `biquarterly`, and `perpetual`.

          Symbols are case-insensitive.
        required: false
        type: string
      - name: filter
        in: query
        description: "Generic table filter. Send JSON key/value pairs, such as `{\"key\": \"value\"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https://www.bitmex.com/app/restAPI#Timestamp-Filters) for more details."
        required: false
        type: string
        format: JSON
      - name: columns
        in: query
        description: |-
          Array of column names to fetch. If omitted, will return all columns.

          Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
        required: false
        type: string
        format: JSON
      - name: count
        in: query
        description: Number of results to fetch. Must be a positive integer.
        required: false
        type: integer
        default: 100
        format: int32
      - name: start
        in: query
        description: Starting point for results.
        required: false
        type: integer
        default: 0
        format: int32
      - name: reverse
        in: query
        description: "If true, will sort results newest first."
        required: false
        type: boolean
        default: false
      - name: startTime
        in: query
        description: Starting date filter for results.
        required: false
        type: string
        format: date-time
      - name: endTime
        in: query
        description: Ending date filter for results.
        required: false
        type: string
        format: date-time
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Trade"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /trade/bucketed:
    get:
      tags:
      - Trade
      summary: Get previous trades in time buckets.
      description: |-
        Timestamps returned by our bucketed endpoints are the **end** of the period, indicating when the bucket was written to disk. Some other common systems use the timestamp as the beginning of the period. Please be aware of this when using this endpoint.

        Also note the `open` price is equal to the `close` price of the previous timeframe bucket.
      operationId: Trade.getBucketed
      parameters:
      - name: binSize
        in: query
        description: "Time interval to bucket by. Available options: [1m,5m,1h,1d]."
        required: false
        type: string
        default: 1m
      - name: partial
        in: query
        description: "If true, will send in-progress (incomplete) bins for the current time period."
        required: false
        type: boolean
        default: false
      - name: symbol
        in: query
        description: |-
          Instrument symbol. Send a bare series (e.g. XBT) to get data for the nearest expiring contract in that series.

          You can also send a timeframe, e.g. `XBT:quarterly`. Timeframes are `nearest`, `daily`, `weekly`, `monthly`, `quarterly`, `biquarterly`, and `perpetual`.

          Symbols are case-insensitive.
        required: false
        type: string
      - name: filter
        in: query
        description: "Generic table filter. Send JSON key/value pairs, such as `{\"key\": \"value\"}`. You can key on individual fields, and do more advanced querying on timestamps. See the [Timestamp Docs](https://www.bitmex.com/app/restAPI#Timestamp-Filters) for more details."
        required: false
        type: string
        format: JSON
      - name: columns
        in: query
        description: |-
          Array of column names to fetch. If omitted, will return all columns.

          Note that this method will always return item keys, even when not specified, so you may receive more columns that you expect.
        required: false
        type: string
        format: JSON
      - name: count
        in: query
        description: Number of results to fetch. Must be a positive integer.
        required: false
        type: integer
        default: 100
        format: int32
      - name: start
        in: query
        description: Starting point for results.
        required: false
        type: integer
        default: 0
        format: int32
      - name: reverse
        in: query
        description: "If true, will sort results newest first."
        required: false
        type: boolean
        default: false
      - name: startTime
        in: query
        description: Starting date filter for results.
        required: false
        type: string
        format: date-time
      - name: endTime
        in: query
        description: Ending date filter for results.
        required: false
        type: string
        format: date-time
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/TradeBin"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/depositAddress:
    get:
      tags:
      - User
      summary: Get a deposit address.
      operationId: User.getDepositAddress
      parameters:
      - name: currency
        in: query
        description: "Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>"
        required: true
        type: string
      - name: network
        in: query
        description: The `network` parameter is used to indicate which blockchain you would like to deposit from. The acceptable value in the `network` parameter for each currency can be found from `networks.asset` from `GET /wallet/assets`.
        required: true
        type: string
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: string
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/depositAddressInformation:
    get:
      tags:
      - User
      summary: Get a deposit address.
      operationId: User.getDepositAddressInformation
      parameters:
      - name: currency
        in: query
        description: "Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>"
        required: true
        type: string
      - name: network
        in: query
        description: The `network` parameter is used to indicate which blockchain you would like to deposit from. The acceptable value in the `network` parameter for each currency can be found from `networks.asset` from `GET /wallet/assets`.
        required: true
        type: string
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/DepositAddress"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/wallet:
    get:
      tags:
      - User
      summary: Get your current wallet information.
      operationId: User.getWallet
      parameters:
      - name: currency
        in: query
        description: "Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>. For all currencies specify \"all\""
        required: false
        type: string
        default: XBt
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/Wallet"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/walletHistory:
    get:
      tags:
      - User
      summary: "Get a history of all of your wallet transactions (deposits, withdrawals, PNL)."
      operationId: User.getWalletHistory
      parameters:
      - name: currency
        in: query
        description: "Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>. For all currencies specify \"all\""
        required: false
        type: string
        default: XBt
      - name: count
        in: query
        description: "Number of results to fetch. Fetch results from start to start + count. Max: 10,000 rows."
        required: false
        type: number
        default: 10000.0
        format: double
      - name: start
        in: query
        description: "Starting point for results, integer. Default 0."
        required: false
        type: number
        default: 0.0
        format: double
      - name: targetAccountId
        in: query
        description: "AccountId to view the history of, must be a paired account with the authorised user requesting the history."
        required: false
        type: number
        format: double
      - name: reverse
        in: query
        description: Start from the latest transaction record. Default true.
        required: false
        type: boolean
        default: true
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Transaction"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/walletSummary:
    get:
      tags:
      - User
      summary: "Get a summary of all of your wallet transactions (deposits, withdrawals, PNL)."
      description: "Provides an aggregated view of transactions, by transaction type, over a specific time period."
      operationId: User.getWalletSummary
      parameters:
      - name: currency
        in: query
        description: "Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>. For all currencies specify \"all\""
        required: false
        type: string
        default: XBt
      - name: startTime
        in: query
        description: Start time for the summary
        required: false
        type: string
        format: date-time
      - name: endTime
        in: query
        description: End time for the summary
        required: false
        type: string
        format: date-time
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/WalletSummaryRecord"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/executionHistory:
    get:
      tags:
      - User
      summary: Get the execution history by day.
      operationId: User.getExecutionHistory
      parameters:
      - name: symbol
        in: query
        required: true
        type: string
        default: XBTUSD
      - name: timestamp
        in: query
        required: true
        type: string
        default: 2017-02-13T12:00:00.000Z
        format: date-time
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Execution"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/staking:
    get:
      tags:
      - User
      summary: Get the current user staking amount.
      operationId: User.getStaking
      parameters:
      - name: currency
        in: query
        required: false
        type: string
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/StakingRecord"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/unstakingRequests:
    get:
      tags:
      - User
      summary: Get the current user unstaking requests
      operationId: User.getUnstakingRequests
      parameters:
      - name: status
        in: query
        required: true
        type: string
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/StakingRecord"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
    post:
      tags:
      - User
      summary: Create unstaking request
      operationId: User.createUnstakingRequests
      parameters:
      - name: symbol
        in: formData
        required: true
        type: string
      - name: amount
        in: formData
        required: true
        type: number
        format: double
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: object
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
    delete:
      tags:
      - User
      summary: Cancel unstaking request
      operationId: User.deleteUnstakingRequests
      parameters:
      - name: redemptionID
        in: formData
        required: true
        type: string
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: object
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/staking/instruments:
    get:
      tags:
      - User
      summary: List staking instruments
      operationId: User.getStakingInstruments
      parameters:
      - name: symbol
        in: query
        required: false
        type: string
      - name: currency
        in: query
        required: false
        type: string
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/x-any"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/staking/tiers:
    get:
      tags:
      - User
      summary: List staking tiers for a given currency
      operationId: User.getStakingTiers
      parameters:
      - name: currency
        in: query
        required: true
        type: string
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/x-any"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/walletTransfer:
    post:
      tags:
      - User
      summary: Execute a transfer to a paired account.
      description: This will send a confirmation email to the email address on record.
      operationId: User.walletTransfer
      parameters:
      - name: currency
        in: formData
        description: "Currency you're transfering. Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>"
        required: true
        type: string
      - name: amount
        in: formData
        description: Amount of transfer.
        required: true
        type: integer
        format: int64
      - name: fromAccountId
        in: formData
        description: AccountID to send the transfer from. Must be paired account with the authenticated user.
        required: false
        type: number
        format: double
      - name: targetAccountId
        in: formData
        description: "AccountId to send the transfer to, must be a paired account with the user sending the transfer."
        required: true
        type: number
        format: double
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/Transaction"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/requestWithdrawal:
    post:
      tags:
      - User
      summary: Request a withdrawal to an external wallet.
      description: This will send a confirmation email to the email address on record.
      operationId: User.requestWithdrawal
      parameters:
      - name: otpToken
        in: formData
        description: 2FA token. Required for all external withdrawals unless the address has skip2FA in addressbook.
        required: false
        type: string
      - name: currency
        in: formData
        description: "Currency you're withdrawing. Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>"
        required: true
        type: string
        default: XBt
      - name: network
        in: formData
        description: The `network` parameter is used to indicate which blockchain you would like to withdraw from. The acceptable value in the `network` parameter for each currency can be found from `networks.asset` from `GET /wallet/assets`.
        required: true
        type: string
      - name: amount
        in: formData
        description: Amount of withdrawal currency.
        required: true
        type: integer
        format: int64
      - name: address
        in: formData
        description: "Destination Address. One of `address`, `addressId`, `targetUserId` has to be specified."
        required: false
        type: string
      - name: memo
        in: formData
        description: "Destination Memo. If `address`, is specified, Destination Memo can also be specified"
        required: false
        type: string
      - name: addressId
        in: formData
        description: "ID of the Destination Address. One of `address`, `addressId`, `targetUserId` has to be specified."
        required: false
        type: number
        format: double
      - name: targetUserId
        in: formData
        description: "ID of the Target User. One of `address`, `addressId`, `targetUserId` has to be specified."
        required: false
        type: number
        format: double
      - name: fee
        in: formData
        description: "Network fee for Bitcoin withdrawals. If not specified, a default value will be calculated based on Bitcoin network conditions. You will have a chance to confirm this via email."
        required: false
        type: number
        format: double
      - name: text
        in: formData
        description: "Optional annotation, e.g. 'Transfer to home wallet'."
        required: false
        type: string
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/Transaction"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/withdrawal:
    delete:
      tags:
      - User
      summary: Cancel pending withdrawal
      operationId: User.cancelPendingWithdrawal
      parameters:
      - name: transactID
        in: formData
        required: true
        type: string
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: object
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/cancelWithdrawal:
    post:
      tags:
      - User
      summary: Cancel a withdrawal.
      operationId: User.cancelWithdrawal
      parameters:
      - name: token
        in: formData
        required: true
        type: string
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/Transaction"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/confirmWithdrawal:
    post:
      tags:
      - User
      summary: Confirm a withdrawal.
      operationId: User.confirmWithdrawal
      parameters:
      - name: token
        in: formData
        required: true
        type: string
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/Transaction"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/confirmEmail:
    post:
      tags:
      - User
      summary: Confirm your email address with a token.
      operationId: User.confirm
      parameters:
      - name: token
        in: formData
        required: true
        type: string
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/AccessToken"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/affiliateStatus:
    get:
      tags:
      - User
      summary: Get your current affiliate/referral status.
      operationId: User.getAffiliateStatus
      parameters:
      - name: currency
        in: query
        description: "Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>. For all currencies specify \"all\""
        required: false
        type: string
        default: XBt
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/Affiliate"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/checkReferralCode:
    get:
      tags:
      - User
      summary: Check if a referral code is valid.
      description: "If the code is valid, responds with the referral code's discount (e.g. `0.1` for 10%). Otherwise, will return a 404 or 451 if invalid."
      operationId: User.checkReferralCode
      parameters:
      - name: referralCode
        in: query
        required: false
        type: string
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: object
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/quoteFillRatio:
    get:
      tags:
      - User
      summary: Get 7 days worth of Quote Fill Ratio statistics.
      operationId: User.getQuoteFillRatio
      parameters:
      - name: targetAccountId
        in: query
        description: "AccountId to get quote fill ratio for, must be a paired account with main user. Can be wildcard * to get all accounts linked to the authenticated user"
        required: false
        type: number
        format: double
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/QuoteFillRatio"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/quoteValueRatio:
    get:
      tags:
      - User
      summary: Get Quote Value Ratio statistics over the last 3 days
      operationId: User.getQuoteValueRatio
      parameters:
      - name: targetAccountId
        in: query
        description: "AccountId to get quote value ratio for, must be a paired account with main user. Can be wildcard * to get all accounts linked to the authenticated user"
        required: false
        type: number
        format: double
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/QuoteValueRatio"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/tradingVolume:
    get:
      tags:
      - User
      summary: Get your 30 days USD average trading volume
      operationId: User.getTradingVolume
      parameters: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/TradingVolume"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/addSubaccount:
    post:
      tags:
      - User
      summary: Creates a new sub-account.
      operationId: User.createSubAccount
      parameters:
      - name: accountName
        in: formData
        required: true
        type: string
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: object
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/updateSubaccount:
    post:
      tags:
      - User
      summary: Updates the sub-account name.
      operationId: User.updateSubAccount
      parameters:
      - name: targetAccountId
        in: formData
        required: true
        type: number
        format: double
      - name: accountName
        in: formData
        required: true
        type: string
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: object
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/getWalletTransferAccounts:
    get:
      tags:
      - User
      summary: Get the list of accounts you can transfer funds between.
      operationId: User.getWalletTransferAccounts
      parameters: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/x-any"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/logout:
    post:
      tags:
      - User
      summary: Log out of BitMEX.
      operationId: User.logout
      parameters: []
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: "null"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/preferences:
    post:
      tags:
      - User
      summary: Save user preferences.
      operationId: User.savePreferences
      parameters:
      - name: prefs
        in: formData
        required: true
        type: string
        format: JSON
      - name: overwrite
        in: formData
        description: "If true, will overwrite all existing preferences."
        required: false
        type: boolean
        default: false
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/User"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user:
    get:
      tags:
      - User
      summary: Get your user model.
      operationId: User.get
      parameters: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/User"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/commission:
    get:
      tags:
      - User
      summary: Get your account's commission status.
      operationId: User.getCommission
      parameters: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/UserCommissionsBySymbol"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/margin:
    get:
      tags:
      - User
      summary: Get your account's margin status. Send a currency of "all" to receive an array of all supported currencies.
      operationId: User.getMargin
      parameters:
      - name: currency
        in: query
        description: "Any currency. For all currencies, see <a href=\"#!/Wallet/Wallet_getAssetsConfig\">asset config endpoint</a>. For all currencies specify \"all\""
        required: false
        type: string
        default: XBt
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/Margin"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/csa:
    get:
      tags:
      - User
      summary: Get your account's CSA status.
      operationId: User.getCSA
      parameters: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/CollateralSupportAgreement"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /user/communicationToken:
    post:
      tags:
      - User
      summary: Register your communication token for mobile clients
      operationId: User.communicationToken
      parameters:
      - name: token
        in: formData
        required: true
        type: string
      - name: platformAgent
        in: formData
        required: true
        type: string
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/CommunicationToken"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /userEvent:
    get:
      tags:
      - UserEvent
      summary: Get your user events
      operationId: UserEvent.get
      parameters:
      - name: count
        in: query
        description: Number of results to fetch.
        required: false
        type: number
        default: 100.0
        format: double
      - name: startId
        in: query
        description: Cursor for pagination.
        required: false
        type: number
        format: double
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/UserEvent"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /wallet/assets:
    get:
      tags:
      - Wallet
      summary: Get Assets Config
      operationId: Wallet.getAssetsConfig
      parameters: []
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/AssetsConfig"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /wallet/networks:
    get:
      tags:
      - Wallet
      summary: Get Networks Config
      operationId: Wallet.getNetworksConfig
      parameters: []
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/NetworksConfig"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /address:
    get:
      tags:
      - Address
      summary: Get your addresses.
      operationId: Address.get
      parameters: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/Address"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
    post:
      tags:
      - Address
      summary: Creates a new saved address.
      operationId: Address.new
      parameters:
      - name: currency
        in: formData
        description: "Currency of the address. Options: `XBt`, `USDt`"
        required: true
        type: string
      - name: network
        in: formData
        description: Selected network.
        required: true
        type: string
      - name: address
        in: formData
        description: Destination Address.
        required: true
        type: string
      - name: name
        in: formData
        description: "Name of the entry, eg. 'Hardware wallet'."
        required: true
        type: string
      - name: note
        in: formData
        description: Optional annotation.
        required: false
        type: string
      - name: skipConfirm
        in: formData
        description: Skip e-mail confirmations for transfers to this address. Will require an email confirmation after creation.
        required: false
        type: boolean
        default: false
      - name: skip2FA
        in: formData
        description: Skip 2FA confirmations for transfers to this address. Will require an email confirmation after creation.
        required: false
        type: boolean
        default: false
      - name: memo
        in: formData
        description: Destination Memo.
        required: false
        type: string
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/Address"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /userAffiliates:
    get:
      tags:
      - UserAffiliates
      summary: Get user's affiliates to a given depth
      operationId: UserAffiliates.get
      parameters:
      - name: depth
        in: query
        description: the depth of affiliates to return. Eg depth = 2 would return direct affiliates and their affiliates
        required: false
        type: number
        format: double
      - name: targetAccountId
        in: query
        description: AccountId of Sub-Affiliate Account
        required: false
        type: number
        format: double
      - name: selectUserId
        in: query
        description: User id of result array to keep
        required: false
        type: number
        format: double
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/x-any"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /guild:
    get:
      tags:
      - Guild
      summary: Get all guilds
      operationId: Guild.get
      parameters: []
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/x-any"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
    post:
      tags:
      - Guild
      summary: Creates a new guild
      operationId: Guild.new
      parameters:
      - name: name
        in: formData
        description: "Name of the guild, must be unique, must be at least 5 characters"
        required: true
        type: string
      - name: emoji
        in: formData
        description: Emoji name.
        required: true
        type: string
      - name: potDistributionPercent
        in: formData
        description: "How much of the pot should be distributed to the guild members, must be between 0 and 100"
        required: true
        type: number
        format: double
      - name: potDistributionType
        in: formData
        description: "How the pot should be distributed to the guild members, must be one of the following: ROLL_OVER, TOP_3, TOP_5, TOP_10, VOLUME_PERCENTAGE, TOP_3_BY_ADV, TOP_5_BY_ADV, TOP_10_BY_ADV, TOP_3_BY_ROI, TOP_5_BY_ROI, TOP_10_BY_ROI, RANDOM"
        required: true
        type: string
      - name: description
        in: formData
        description: "Guild description, can be used to explain the guild to other users."
        required: false
        type: string
      - name: twitter
        in: formData
        description: Guild twitter handle.
        required: false
        type: string
      - name: discord
        in: formData
        description: Guild discord link.
        required: false
        type: string
      - name: telegram
        in: formData
        description: Guild telegram link.
        required: false
        type: string
      - name: imgUrl
        in: formData
        description: "URL for the profile image of the guild, is used by clients to add some color to the guild, if no image is provided, a default image is used"
        required: false
        type: string
      - name: isPrivate
        in: formData
        description: Guild privacy status
        required: false
        type: boolean
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/Guild"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
    put:
      tags:
      - Guild
      summary: Edit guild new guild
      operationId: Guild.edit
      parameters:
      - name: name
        in: formData
        description: "Name of the guild, must be unique, must be at least 5 characters"
        required: true
        type: string
      - name: emoji
        in: formData
        description: Emoji name.
        required: true
        type: string
      - name: potDistributionPercent
        in: formData
        description: "How much of the pot should be distributed to the guild members, must be between 0 and 100"
        required: true
        type: number
        format: double
      - name: potDistributionType
        in: formData
        description: "How the pot should be distributed to the guild members, must be one of the following: ROLL_OVER, TOP_3, TOP_5, TOP_10, VOLUME_PERCENTAGE, TOP_3_BY_ADV, TOP_5_BY_ADV, TOP_10_BY_ADV, TOP_3_BY_ROI, TOP_5_BY_ROI, TOP_10_BY_ROI, RANDOM"
        required: true
        type: string
      - name: potTraderId
        in: formData
        description: User ID of the guild member with order write permission for the pot
        required: false
        type: number
        format: double
      - name: description
        in: formData
        description: "Guild description, can be used to explain the guild to other users."
        required: false
        type: string
      - name: twitter
        in: formData
        description: Guild twitter handle.
        required: false
        type: string
      - name: discord
        in: formData
        description: Guild discord link.
        required: false
        type: string
      - name: telegram
        in: formData
        description: Guild telegram link.
        required: false
        type: string
      - name: imgUrl
        in: formData
        description: "URL for the profile image of the guild, is used by clients to add some color to the guild, if no image is provided, a default image is used"
        required: false
        type: string
      - name: isPrivate
        in: formData
        description: Guild privacy status
        required: false
        type: boolean
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/Guild"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /guild/shareTrades:
    post:
      tags:
      - Guild
      summary: "Toggle share trades for your account, which controls whether your guild members can see your orders and positions in their UI"
      operationId: Guild.shareTrades
      parameters:
      - name: shareTrades
        in: formData
        required: true
        type: boolean
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: object
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /guild/leave:
    post:
      tags:
      - Guild
      summary: Leave guild or cancel guild join request
      operationId: Guild.leave
      parameters: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: object
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /guild/kick:
    post:
      tags:
      - Guild
      summary: Kick member from guild
      operationId: Guild.kick
      parameters:
      - name: memberUserId
        in: formData
        required: true
        type: number
        format: double
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: object
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /guild/join:
    post:
      tags:
      - Guild
      summary: Request to Join a private guild or join a public guild
      operationId: Guild.join
      parameters:
      - name: code
        in: formData
        required: true
        type: string
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: object
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /guild/archive:
    post:
      tags:
      - Guild
      summary: Archive a guild
      operationId: Guild.archive
      parameters: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: object
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /porl/nonce:
    get:
      tags:
      - Porl
      summary: Get your Proof of Reserves nonce and data.
      description: |
        ## Proof of Reserves Nonce

        This endpoint will return the nonce and associated data needed to validate BitMEX reserves data.

        <! TODO link to docs, GitHub, etc >
      operationId: Porl.getNonce
      parameters: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            $ref: "#/definitions/Porl"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
  /porl/snapshots:
    get:
      tags:
      - Porl
      summary: Get Proof of Reserves historical snapshots
      operationId: Porl.getSnapshots
      parameters: []
      security: []
      deprecated: false
      responses:
        "200":
          description: Request was successful
          schema:
            type: array
            items:
              $ref: "#/definitions/x-any"
        "400":
          description: Parameter Error
          schema:
            $ref: "#/definitions/Error"
        "401":
          description: Unauthorized
          schema:
            $ref: "#/definitions/Error"
        "403":
          description: Access Denied
          schema:
            $ref: "#/definitions/Error"
        "404":
          description: Not Found
          schema:
            $ref: "#/definitions/Error"
securityDefinitions:
  apiKey:
    type: apiKey
    name: api-key
    in: header
  apiSignature:
    type: apiKey
    name: api-signature
    in: header
  apiExpires:
    type: apiKey
    name: api-expires
    in: header
definitions:
  Announcement:
    type: object
    required:
    - id
    properties:
      id:
        type: integer
        format: int32
      link:
        type: string
      title:
        type: string
      content:
        type: string
      date:
        type: string
        format: date-time
    description: Public Announcements
  Error:
    type: object
    required:
    - error
    properties:
      error:
        $ref: "#/definitions/Error_error"
  APIKey:
    type: object
    required:
    - id
    - name
    - nonce
    - secret
    - userId
    properties:
      id:
        type: string
        maxLength: 24
      secret:
        type: string
        maxLength: 48
      name:
        type: string
        maxLength: 64
      nonce:
        type: integer
        format: int64
        default: 0
      cidr:
        type: string
        maxLength: 18
      cidrs:
        type: array
        items:
          $ref: "#/definitions/x-any"
      targetAccountId:
        type: integer
        format: int32
      permissions:
        type: array
        items:
          $ref: "#/definitions/x-any"
      enabled:
        type: boolean
        default: false
      userId:
        type: integer
        format: int32
      created:
        type: string
        format: date-time
    description: Persistent API Keys for Developers
  PinnedMessage:
    type: object
    required:
    - channelID
    - id
    - messageId
    properties:
      id:
        type: integer
        format: int32
      channelID:
        type: integer
        format: int32
      messageId:
        type: integer
        format: int32
      created:
        type: string
        format: date-time
      ended:
        type: string
        format: date-time
      createdUserId:
        type: number
        format: double
      endedUserId:
        type: number
        format: double
    description: Pinned Messages
  Chat:
    type: object
    required:
    - date
    - html
    - message
    - user
    properties:
      id:
        type: integer
        format: int32
      date:
        type: string
        format: date-time
      user:
        type: string
      userColor:
        type: string
      message:
        type: string
      html:
        type: string
      channelID:
        type: number
        format: double
    description: Trollbox Data
  ChatChannel:
    type: object
    required:
    - isPrivate
    - name
    properties:
      id:
        type: integer
        format: int32
      name:
        type: string
      isPrivate:
        type: boolean
  ConnectedUsers:
    type: object
    properties:
      users:
        type: integer
        format: int32
      bots:
        type: integer
        format: int32
  Execution:
    type: object
    required:
    - symbol
    - timestamp
    properties:
      execID:
        type: string
        format: guid
      orderID:
        type: string
        format: guid
      clOrdID:
        type: string
      clOrdLinkID:
        type: string
      account:
        type: integer
        format: int64
      symbol:
        type: string
      side:
        type: string
      lastQty:
        type: integer
        format: int64
      lastPx:
        type: number
        format: double
      lastLiquidityInd:
        type: string
      orderQty:
        type: integer
        format: int64
      price:
        type: number
        format: double
      displayQty:
        type: integer
        format: int64
      stopPx:
        type: number
        format: double
      pegOffsetValue:
        type: number
        format: double
      pegPriceType:
        type: string
      currency:
        type: string
      settlCurrency:
        type: string
      execType:
        type: string
      ordType:
        type: string
      timeInForce:
        type: string
      execInst:
        type: string
      contingencyType:
        type: string
      ordStatus:
        type: string
      triggered:
        type: string
      workingIndicator:
        type: boolean
      ordRejReason:
        type: string
      leavesQty:
        type: integer
        format: int64
      cumQty:
        type: integer
        format: int64
      avgPx:
        type: number
        format: double
      commission:
        type: number
        format: double
      feeType:
        type: string
      tradePublishIndicator:
        type: string
      text:
        type: string
      trdMatchID:
        type: string
        format: guid
      execCost:
        type: integer
        format: int64
      execComm:
        type: integer
        format: int64
      homeNotional:
        type: number
        format: double
      foreignNotional:
        type: number
        format: double
      transactTime:
        type: string
        format: date-time
      timestamp:
        type: string
        format: date-time
    description: Raw Order and Balance Data
  x-any:
    type: object
  Funding:
    type: object
    required:
    - symbol
    - timestamp
    properties:
      timestamp:
        type: string
        format: date-time
      symbol:
        type: string
      fundingInterval:
        type: string
        format: date-time
      fundingRate:
        type: number
        format: double
      fundingRateDaily:
        type: number
        format: double
    description: Swap Funding History
  Instrument:
    type: object
    required:
    - symbol
    properties:
      symbol:
        type: string
      rootSymbol:
        type: string
      state:
        type: string
      typ:
        type: string
      listing:
        type: string
        format: date-time
      front:
        type: string
        format: date-time
      expiry:
        type: string
        format: date-time
      settle:
        type: string
        format: date-time
      listedSettle:
        type: string
        format: date-time
      positionCurrency:
        type: string
      underlying:
        type: string
      quoteCurrency:
        type: string
      underlyingSymbol:
        type: string
      reference:
        type: string
      referenceSymbol:
        type: string
      calcInterval:
        type: string
        format: date-time
      publishInterval:
        type: string
        format: date-time
      publishTime:
        type: string
        format: date-time
      maxOrderQty:
        type: integer
        format: int64
      maxPrice:
        type: number
        format: double
      lotSize:
        type: integer
        format: int64
      tickSize:
        type: number
        format: double
      multiplier:
        type: integer
        format: int64
      settlCurrency:
        type: string
      underlyingToPositionMultiplier:
        type: integer
        format: int64
      underlyingToSettleMultiplier:
        type: integer
        format: int64
      quoteToSettleMultiplier:
        type: integer
        format: int64
      isQuanto:
        type: boolean
      isInverse:
        type: boolean
      initMargin:
        type: number
        format: double
      maintMargin:
        type: number
        format: double
      riskLimit:
        type: integer
        format: int64
      riskStep:
        type: integer
        format: int64
      limit:
        type: number
        format: double
      taxed:
        type: boolean
      deleverage:
        type: boolean
      makerFee:
        type: number
        format: double
      takerFee:
        type: number
        format: double
      settlementFee:
        type: number
        format: double
      fundingBaseSymbol:
        type: string
      fundingQuoteSymbol:
        type: string
      fundingPremiumSymbol:
        type: string
      fundingTimestamp:
        type: string
        format: date-time
      fundingInterval:
        type: string
        format: date-time
      fundingRate:
        type: number
        format: double
      indicativeFundingRate:
        type: number
        format: double
      rebalanceTimestamp:
        type: string
        format: date-time
      rebalanceInterval:
        type: string
        format: date-time
      prevClosePrice:
        type: number
        format: double
      limitDownPrice:
        type: number
        format: double
      limitUpPrice:
        type: number
        format: double
      totalVolume:
        type: integer
        format: int64
      volume:
        type: integer
        format: int64
      volume24h:
        type: integer
        format: int64
      prevTotalTurnover:
        type: integer
        format: int64
      totalTurnover:
        type: integer
        format: int64
      turnover:
        type: integer
        format: int64
      turnover24h:
        type: integer
        format: int64
      homeNotional24h:
        type: number
        format: double
      foreignNotional24h:
        type: number
        format: double
      prevPrice24h:
        type: number
        format: double
      vwap:
        type: number
        format: double
      highPrice:
        type: number
        format: double
      lowPrice:
        type: number
        format: double
      lastPrice:
        type: number
        format: double
      lastPriceProtected:
        type: number
        format: double
      lastTickDirection:
        type: string
      lastChangePcnt:
        type: number
        format: double
      bidPrice:
        type: number
        format: double
      midPrice:
        type: number
        format: double
      askPrice:
        type: number
        format: double
      impactBidPrice:
        type: number
        format: double
      impactMidPrice:
        type: number
        format: double
      impactAskPrice:
        type: number
        format: double
      hasLiquidity:
        type: boolean
      openInterest:
        type: integer
        format: int64
      openValue:
        type: integer
        format: int64
      fairMethod:
        type: string
      fairBasisRate:
        type: number
        format: double
      fairBasis:
        type: number
        format: double
      fairPrice:
        type: number
        format: double
      markMethod:
        type: string
      markPrice:
        type: number
        format: double
      indicativeSettlePrice:
        type: number
        format: double
      settledPriceAdjustmentRate:
        type: number
        format: double
      settledPrice:
        type: number
        format: double
      instantPnl:
        type: boolean
      minTick:
        type: number
        format: double
      timestamp:
        type: string
        format: date-time
    description: "Tradeable Contracts, Indices, and History"
  InstrumentInterval:
    type: object
    required:
    - intervals
    - symbols
    properties:
      intervals:
        type: array
        items:
          type: string
      symbols:
        type: array
        items:
          type: string
  IndexComposite:
    type: object
    required:
    - timestamp
    properties:
      timestamp:
        type: string
        format: date-time
      symbol:
        type: string
      indexSymbol:
        type: string
      indexMultiplier:
        type: number
        format: double
      reference:
        type: string
      lastPrice:
        type: number
        format: double
      sourcePrice:
        type: number
        format: double
      conversionIndex:
        type: string
      conversionIndexPrice:
        type: number
        format: double
      weight:
        type: number
        format: double
      logged:
        type: string
        format: date-time
  StatsUSDBySymbol:
    type: object
    required:
    - symbol
    properties:
      symbol:
        type: string
      currency:
        type: string
      turnover24h:
        type: integer
        format: int64
      turnover30d:
        type: integer
        format: int64
      turnover365d:
        type: integer
        format: int64
      turnover:
        type: integer
        format: int64
  Insurance:
    type: object
    required:
    - currency
    - timestamp
    properties:
      currency:
        type: string
      timestamp:
        type: string
        format: date-time
      walletBalance:
        type: integer
        format: int64
    description: Insurance Fund Data
  Leaderboard:
    type: object
    required:
    - name
    properties:
      name:
        type: string
      isRealName:
        type: boolean
      profit:
        type: number
        format: double
    description: Information on Top Users
  Liquidation:
    type: object
    required:
    - orderID
    properties:
      orderID:
        type: string
        format: guid
      symbol:
        type: string
      side:
        type: string
      price:
        type: number
        format: double
      leavesQty:
        type: integer
        format: int64
    description: Active Liquidations
  GlobalNotification:
    type: object
    required:
    - body
    - date
    - title
    - ttl
    properties:
      id:
        type: integer
        format: int32
      date:
        type: string
        format: date-time
      title:
        type: string
      body:
        type: string
      ttl:
        type: integer
        format: int32
      type:
        type: string
        enum:
        - success
        - error
        - info
      closable:
        type: boolean
        default: true
      persist:
        type: boolean
        default: true
      waitForVisibility:
        type: boolean
        default: true
      sound:
        type: string
    description: Account Notifications
  Order:
    type: object
    required:
    - orderID
    properties:
      orderID:
        type: string
        format: guid
      clOrdID:
        type: string
      clOrdLinkID:
        type: string
      account:
        type: integer
        format: int64
      symbol:
        type: string
      side:
        type: string
      orderQty:
        type: integer
        format: int64
      price:
        type: number
        format: double
      displayQty:
        type: integer
        format: int64
      stopPx:
        type: number
        format: double
      pegOffsetValue:
        type: number
        format: double
      pegPriceType:
        type: string
      currency:
        type: string
      settlCurrency:
        type: string
      ordType:
        type: string
      timeInForce:
        type: string
      execInst:
        type: string
      contingencyType:
        type: string
      ordStatus:
        type: string
      triggered:
        type: string
      workingIndicator:
        type: boolean
      ordRejReason:
        type: string
      leavesQty:
        type: integer
        format: int64
      cumQty:
        type: integer
        format: int64
      avgPx:
        type: number
        format: double
      text:
        type: string
      transactTime:
        type: string
        format: date-time
      timestamp:
        type: string
        format: date-time
    description: "Placement, Cancellation, Amending, and History"
  OrderBookL2:
    type: object
    required:
    - id
    - side
    - symbol
    properties:
      symbol:
        type: string
      id:
        type: integer
        format: int64
      side:
        type: string
      size:
        type: integer
        format: int64
      price:
        type: number
        format: double
      timestamp:
        type: string
        format: date-time
  Position:
    type: object
    required:
    - account
    - symbol
    properties:
      account:
        type: integer
        format: int64
        default: 0
      symbol:
        type: string
      currency:
        type: string
      underlying:
        type: string
      quoteCurrency:
        type: string
      commission:
        type: number
        format: double
        default: 0.0
      initMarginReq:
        type: number
        format: double
        default: 0.0
      maintMarginReq:
        type: number
        format: double
        default: 0.0
      riskLimit:
        type: integer
        format: int64
        default: 0
      leverage:
        type: number
        format: double
        default: 0.0
      crossMargin:
        type: boolean
      deleveragePercentile:
        type: number
        format: double
        default: 0.0
      rebalancedPnl:
        type: integer
        format: int64
        default: 0
      prevRealisedPnl:
        type: integer
        format: int64
        default: 0
      prevUnrealisedPnl:
        type: integer
        format: int64
        default: 0
      openingQty:
        type: integer
        format: int64
        default: 0
      openOrderBuyQty:
        type: integer
        format: int64
        default: 0
      openOrderBuyCost:
        type: integer
        format: int64
        default: 0
      openOrderBuyPremium:
        type: integer
        format: int64
        default: 0
      openOrderSellQty:
        type: integer
        format: int64
        default: 0
      openOrderSellCost:
        type: integer
        format: int64
        default: 0
      openOrderSellPremium:
        type: integer
        format: int64
        default: 0
      currentQty:
        type: integer
        format: int64
        default: 0
      currentCost:
        type: integer
        format: int64
        default: 0
      currentComm:
        type: integer
        format: int64
        default: 0
      realisedCost:
        type: integer
        format: int64
        default: 0
      unrealisedCost:
        type: integer
        format: int64
        default: 0
      grossOpenPremium:
        type: integer
        format: int64
        default: 0
      isOpen:
        type: boolean
      markPrice:
        type: number
        format: double
        default: 0.0
      markValue:
        type: integer
        format: int64
        default: 0
      riskValue:
        type: integer
        format: int64
        default: 0
      homeNotional:
        type: number
        format: double
        default: 0.0
      foreignNotional:
        type: number
        format: double
        default: 0.0
      posState:
        type: string
      posCost:
        type: integer
        format: int64
        default: 0
      posCross:
        type: integer
        format: int64
        default: 0
      posComm:
        type: integer
        format: int64
        default: 0
      posLoss:
        type: integer
        format: int64
        default: 0
      posMargin:
        type: integer
        format: int64
        default: 0
      posMaint:
        type: integer
        format: int64
        default: 0
      initMargin:
        type: integer
        format: int64
        default: 0
      maintMargin:
        type: integer
        format: int64
        default: 0
      realisedPnl:
        type: integer
        format: int64
        default: 0
      unrealisedPnl:
        type: integer
        format: int64
        default: 0
      unrealisedPnlPcnt:
        type: number
        format: double
        default: 0.0
      unrealisedRoePcnt:
        type: number
        format: double
        default: 0.0
      avgCostPrice:
        type: number
        format: double
        default: 0.0
      avgEntryPrice:
        type: number
        format: double
        default: 0.0
      breakEvenPrice:
        type: number
        format: double
        default: 0.0
      marginCallPrice:
        type: number
        format: double
        default: 0.0
      liquidationPrice:
        type: number
        format: double
        default: 0.0
      bankruptPrice:
        type: number
        format: double
        default: 0.0
      timestamp:
        type: string
        format: date-time
    description: Summary of Open and Closed Positions
  Quote:
    type: object
    required:
    - symbol
    - timestamp
    properties:
      timestamp:
        type: string
        format: date-time
      symbol:
        type: string
      bidSize:
        type: integer
        format: int64
      bidPrice:
        type: number
        format: double
      askPrice:
        type: number
        format: double
      askSize:
        type: integer
        format: int64
    description: Best Bid/Offer Snapshots & Historical Bins
  Settlement:
    type: object
    required:
    - symbol
    - timestamp
    properties:
      timestamp:
        type: string
        format: date-time
      symbol:
        type: string
      settlementType:
        type: string
      settledPrice:
        type: number
        format: double
      optionStrikePrice:
        type: number
        format: double
      optionUnderlyingPrice:
        type: number
        format: double
      bankrupt:
        type: integer
        format: int64
      taxBase:
        type: integer
        format: int64
      taxRate:
        type: number
        format: double
    description: Historical Settlement Data
  Stats:
    type: object
    required:
    - rootSymbol
    properties:
      rootSymbol:
        type: string
      currency:
        type: string
      volume24h:
        type: integer
        format: int64
      turnover24h:
        type: integer
        format: int64
      openInterest:
        type: integer
        format: int64
      openValue:
        type: integer
        format: int64
    description: Exchange Statistics
  StatsHistory:
    type: object
    required:
    - date
    - rootSymbol
    properties:
      date:
        type: string
        format: date-time
      rootSymbol:
        type: string
      currency:
        type: string
      volume:
        type: integer
        format: int64
      turnover:
        type: integer
        format: int64
  StatsUSD:
    type: object
    required:
    - rootSymbol
    properties:
      rootSymbol:
        type: string
      currency:
        type: string
      turnover24h:
        type: integer
        format: int64
      turnover30d:
        type: integer
        format: int64
      turnover365d:
        type: integer
        format: int64
      turnover:
        type: integer
        format: int64
  Trade:
    type: object
    required:
    - symbol
    - timestamp
    properties:
      timestamp:
        type: string
        format: date-time
      symbol:
        type: string
      side:
        type: string
      size:
        type: integer
        format: int64
      price:
        type: number
        format: double
      tickDirection:
        type: string
      trdMatchID:
        type: string
        format: guid
      grossValue:
        type: integer
        format: int64
      homeNotional:
        type: number
        format: double
      foreignNotional:
        type: number
        format: double
      trdType:
        type: string
    description: Individual & Bucketed Trades
  TradeBin:
    type: object
    required:
    - symbol
    - timestamp
    properties:
      timestamp:
        type: string
        format: date-time
      symbol:
        type: string
      open:
        type: number
        format: double
      high:
        type: number
        format: double
      low:
        type: number
        format: double
      close:
        type: number
        format: double
      trades:
        type: integer
        format: int64
      volume:
        type: integer
        format: int64
      vwap:
        type: number
        format: double
      lastSize:
        type: integer
        format: int64
      turnover:
        type: integer
        format: int64
      homeNotional:
        type: number
        format: double
      foreignNotional:
        type: number
        format: double
  DepositAddress:
    type: object
    required:
    - address
    properties:
      address:
        type: string
      memo:
        type: string
    description: Deposit Address
  Wallet:
    type: object
    required:
    - account
    - currency
    properties:
      account:
        type: integer
        format: int64
      currency:
        type: string
      deposited:
        type: integer
        format: int64
      withdrawn:
        type: integer
        format: int64
      transferIn:
        type: integer
        format: int64
      transferOut:
        type: integer
        format: int64
      amount:
        type: integer
        format: int64
      pendingCredit:
        type: integer
        format: int64
      pendingDebit:
        type: integer
        format: int64
      confirmedDebit:
        type: integer
        format: int64
      timestamp:
        type: string
        format: date-time
    description: Assets and Networks Data
  Transaction:
    type: object
    required:
    - transactID
    properties:
      transactID:
        type: string
        format: guid
      account:
        type: integer
        format: int64
      currency:
        type: string
      network:
        type: string
      transactType:
        type: string
      amount:
        type: integer
        format: int64
      fee:
        type: integer
        format: int64
      transactStatus:
        type: string
      address:
        type: string
      tx:
        type: string
      text:
        type: string
      transactTime:
        type: string
        format: date-time
      timestamp:
        type: string
        format: date-time
      walletBalance:
        type: integer
        format: int64
  WalletSummaryRecord:
    type: object
    required:
    - account
    properties:
      account:
        type: number
        format: double
      currency:
        type: string
        default: XBt
      transactType:
        type: string
      symbol:
        type: string
        default: XBTUSD
      amount:
        type: number
        format: double
        default: 0.0
      pendingDebit:
        type: number
        format: double
        default: 0.0
      realisedPnl:
        type: number
        format: double
        default: 0.0
      walletBalance:
        type: number
        format: double
        default: 0.0
      unrealisedPnl:
        type: number
        format: double
        default: 0.0
      marginBalance:
        type: number
        format: double
        default: 0.0
  StakingRecord:
    type: object
    required:
    - account
    properties:
      account:
        type: number
        format: double
      amount:
        type: number
        format: double
      currency:
        type: string
        default: XBt
    description: Get the current user staking amount in vertical format.
  AccessToken:
    type: object
    required:
    - id
    - updated
    properties:
      updated:
        type: string
        format: date-time
      authorizedAccounts:
        type: object
        properties: {}
      id:
        type: string
      ttl:
        type: number
        format: double
        description: time to live in seconds (2 weeks by default)
        default: 1209600.0
      created:
        type: string
        format: date-time
      userId:
        type: number
        format: double
  Affiliate:
    type: object
    required:
    - account
    - currency
    properties:
      account:
        type: integer
        format: int64
      currency:
        type: string
      prevPayout:
        type: integer
        format: int64
      prevTurnover:
        type: integer
        format: int64
      prevComm:
        type: integer
        format: int64
      prevTimestamp:
        type: string
        format: date-time
      execTurnover:
        type: integer
        format: int64
      execComm:
        type: integer
        format: int64
      totalReferrals:
        type: integer
        format: int64
      totalTurnover:
        type: integer
        format: int64
      totalComm:
        type: integer
        format: int64
      payoutPcnt:
        type: number
        format: double
      pendingPayout:
        type: integer
        format: int64
      timestamp:
        type: string
        format: date-time
      referrerAccount:
        type: number
        format: double
      referralDiscount:
        type: number
        format: double
      affiliatePayout:
        type: number
        format: double
  QuoteFillRatio:
    type: object
    required:
    - date
    properties:
      date:
        type: string
        format: date-time
      account:
        type: number
        format: double
      quoteCount:
        type: number
        format: double
      dealtCount:
        type: number
        format: double
      quotesMavg7:
        type: number
        format: double
      dealtMavg7:
        type: number
        format: double
      quoteFillRatioMavg7:
        type: number
        format: double
    description: Daily Quote Fill Ratio Statistic
  QuoteValueRatio:
    type: object
    properties:
      timestamp:
        type: string
        format: date-time
      account:
        type: number
        format: double
      symbol:
        type: string
      quoteCount:
        type: number
        format: double
      volumeXBT:
        type: number
        format: double
      QVR:
        type: number
        format: double
      id:
        type: number
        format: double
    description: Hourly Quote Value Ratio Statistic
  TradingVolume:
    type: object
    required:
    - advUsd
    properties:
      advUsd:
        type: number
        format: double
      advUsdSpot:
        type: number
        format: double
      advUsdContract:
        type: number
        format: double
    description: 30 days USD average trading volume
  User:
    type: object
    required:
    - isUser
    - username
    properties:
      id:
        type: integer
        format: int32
      firstname:
        type: string
      lastname:
        type: string
      username:
        type: string
      accountName:
        type: string
      isUser:
        type: boolean
        default: true
      email:
        type: string
      dateOfBirth:
        type: string
      phone:
        type: string
      created:
        type: string
        format: date-time
      lastUpdated:
        type: string
        format: date-time
      preferences:
        $ref: "#/definitions/UserPreferences"
      TFAEnabled:
        type: string
      affiliateID:
        type: string
        maxLength: 6
      country:
        type: string
        maxLength: 3
      geoipCountry:
        type: string
        maxLength: 2
      geoipRegion:
        type: string
        maxLength: 2
      firstTradeTimestamp:
        type: string
        format: date-time
      firstDepositTimestamp:
        type: string
        format: date-time
      typ:
        type: string
    description: Account Operations
  UserCommissionsBySymbol:
    type: object
  Margin:
    type: object
    required:
    - account
    - currency
    properties:
      account:
        type: integer
        format: int64
        default: 0
      currency:
        type: string
      riskLimit:
        type: integer
        format: int64
        default: 0
      state:
        type: string
      amount:
        type: integer
        format: int64
        default: 0
      prevRealisedPnl:
        type: integer
        format: int64
        default: 0
      grossComm:
        type: integer
        format: int64
        default: 0
      grossOpenCost:
        type: integer
        format: int64
        default: 0
      grossOpenPremium:
        type: integer
        format: int64
        default: 0
      grossExecCost:
        type: integer
        format: int64
        default: 0
      grossMarkValue:
        type: integer
        format: int64
        default: 0
      riskValue:
        type: integer
        format: int64
        default: 0
      initMargin:
        type: integer
        format: int64
        default: 0
      maintMargin:
        type: integer
        format: int64
        default: 0
      targetExcessMargin:
        type: integer
        format: int64
        default: 0
      realisedPnl:
        type: integer
        format: int64
        default: 0
      unrealisedPnl:
        type: integer
        format: int64
        default: 0
      walletBalance:
        type: integer
        format: int64
        default: 0
      marginBalance:
        type: integer
        format: int64
        default: 0
      marginLeverage:
        type: number
        format: double
        default: 0.0
      marginUsedPcnt:
        type: number
        format: double
        default: 0.0
      excessMargin:
        type: integer
        format: int64
        default: 0
      availableMargin:
        type: integer
        format: int64
        default: 0
      withdrawableMargin:
        type: integer
        format: int64
        default: 0
      makerFeeDiscount:
        type: number
        format: double
        default: 0.0
      takerFeeDiscount:
        type: number
        format: double
        default: 0.0
      timestamp:
        type: string
        format: date-time
  CollateralSupportAgreement:
    type: object
    required:
    - csaID
    properties:
      csaID:
        type: string
      account:
        type: integer
        format: int64
      currency:
        type: string
      amount:
        type: integer
        format: int64
      minAmount:
        type: integer
        format: int64
      threshold:
        type: integer
        format: int64
      mmRatioMarginCall:
        type: integer
        format: int64
      mmRatioLiquidation:
        type: integer
        format: int64
      startTime:
        type: string
      maturityTime:
        type: string
      maturityInstruction:
        type: string
      csaStatus:
        type: string
      requester:
        type: string
      clientDetails:
        type: string
      text:
        type: string
      timestamp:
        type: string
  CommunicationToken:
    type: object
    required:
    - channel
    - deviceToken
    - id
    - userId
    properties:
      id:
        type: string
      userId:
        type: integer
        format: int32
      deviceToken:
        type: string
      channel:
        type: string
    description: User communication SNS token
  UserEvent:
    type: object
    required:
    - created
    - createdById
    - status
    - type
    - userId
    properties:
      id:
        type: number
        format: double
      type:
        type: string
        enum:
        - apiKeyCreated
        - deleverageExecution
        - depositConfirmed
        - depositPending
        - banZeroVolumeApiUser
        - liquidationOrderPlaced
        - login
        - existingAccountRegistrationAttempt
        - passwordChanged
        - positionStateLiquidated
        - positionStateWarning
        - resetPasswordConfirmed
        - resetPasswordRequest
        - transferCanceled
        - transferCompleted
        - transferReceived
        - transferRequested
        - twoFactorDisabled
        - twoFactorEnabled
        - withdrawalCanceled
        - withdrawalCompleted
        - withdrawalConfirmed
        - withdrawalRequested
        - addressSkipConfirmRequested
        - addressSkipConfirmVerified
        - verify
        - restrictedAccount
        - unrestrictedAccount
        - disabledAccount
        - enabledAccount
        - role:roleMappingDestroy
        - role:chatBanned
        - role:withdrawalBanned
        - role:orderBanned
        - role:apiBanned
        - role:restrictedJurisdictionPrivilege
      status:
        type: string
        enum:
        - success
        - failure
      userId:
        type: number
        format: double
      createdById:
        type: number
        format: double
      ip:
        type: string
      geoipCountry:
        type: string
        maxLength: 2
      geoipRegion:
        type: string
        maxLength: 3
      geoipSubRegion:
        type: string
        maxLength: 3
      eventMeta:
        type: object
        properties: {}
      created:
        type: string
        format: date-time
    description: User Events for Auditing
  AssetsConfig:
    type: object
    required:
    - asset
    properties:
      asset:
        type: string
        default: XBT
      currency:
        type: string
        default: XBt
      majorCurrency:
        type: string
        default: XBT
      name:
        type: string
        default: Bitcoin
      currencyType:
        type: string
        default: Crypto
      scale:
        type: number
        format: double
        default: 8.0
      enabled:
        type: boolean
        default: true
      isMarginCurrency:
        type: boolean
        default: true
      memoRequired:
        type: boolean
        default: false
      networks:
        type: array
        items:
          $ref: "#/definitions/AssetsConfigNetworkItem"
  NetworksConfig:
    type: object
    required:
    - network
    properties:
      network:
        type: string
        default: eth
      name:
        type: string
        default: Ethereum
      currency:
        type: string
        default: Gwei
      networkSymbol:
        type: string
        default: ETH
      transactionExplorer:
        type: string
        default: https://etherscan.io/tx/
      tokenExplorer:
        type: string
        default: https://etherscan.io/token/
      depositConfirmations:
        type: integer
        format: int32
      enabled:
        type: boolean
        default: true
  Address:
    type: object
    required:
    - address
    - name
    - network
    properties:
      id:
        type: integer
        format: int32
      currency:
        type: string
      created:
        type: string
        format: date-time
      userId:
        type: number
        format: double
      address:
        type: string
      name:
        type: string
      note:
        type: string
      skipConfirm:
        type: boolean
      skipConfirmVerified:
        type: boolean
      skip2FA:
        type: boolean
      skip2FAVerified:
        type: boolean
      network:
        type: string
      memo:
        type: string
  Guild:
    type: object
    required:
    - chatChannelId
    - created
    - isPrivate
    - name
    - updated
    properties:
      id:
        type: integer
        format: int32
      created:
        type: string
        format: date-time
      updated:
        type: string
        format: date-time
      archived:
        type: boolean
      name:
        type: string
      imgUrl:
        type: string
      mobileHeroImgUrl:
        type: string
      emoji:
        type: string
      logoUrl:
        type: string
      description:
        type: string
      chatChannelId:
        type: number
        format: double
      isPrivate:
        type: boolean
      affiliateId:
        type: string
      potDistributionPreferences:
        type: object
        properties: {}
      socials:
        type: object
        properties: {}
      deleted:
        type: boolean
  Porl:
    type: object
    required:
    - account
    - accountNonce
    - balance
    - created
    - height
    - total
    properties:
      account:
        type: integer
        format: int32
      nonce:
        type: string
      accountNonce:
        type: string
      total:
        type: number
        format: double
      balance:
        type: number
        format: double
      filename:
        type: string
      height:
        type: number
        format: double
      created:
        type: string
        format: date-time
    description: Proof of Reserves/Liabilities
  UserPreferences:
    type: object
    properties:
      alertOnLiquidations:
        type: boolean
      animationsEnabled:
        type: boolean
      announcementsLastSeen:
        type: string
        format: date-time
      chatChannelID:
        type: number
        format: double
      colorTheme:
        type: string
      currency:
        type: string
      debug:
        type: boolean
      disableEmails:
        type: array
        items:
          type: string
      disablePush:
        type: array
        items:
          type: string
      displayCorpEnrollUpsell:
        type: boolean
      equivalentCurrency:
        type: string
      features:
        type: array
        items:
          type: string
      favourites:
        type: array
        items:
          type: string
      favouritesAssets:
        type: array
        items:
          type: string
      favouritesOrdered:
        type: array
        items:
          type: string
      favouriteBots:
        type: array
        items:
          type: string
      hasSetTradingCurrencies:
        type: boolean
      hideConfirmDialogs:
        type: array
        items:
          type: string
      hideConnectionModal:
        type: boolean
      hideFromLeaderboard:
        type: boolean
        default: false
      hideNameFromLeaderboard:
        type: boolean
        default: true
      hidePnlInGuilds:
        type: boolean
        default: false
      hideRoiInGuilds:
        type: boolean
        default: false
      hideNotifications:
        type: array
        items:
          type: string
      hidePhoneConfirm:
        type: boolean
        default: false
      isSensitiveInfoVisible:
        type: boolean
      isWalletZeroBalanceHidden:
        type: boolean
      locale:
        type: string
        default: en-US
      localeSetTime:
        type: number
        format: double
      marginPnlRow:
        type: string
      marginPnlRowKind:
        type: string
      mobileLocale:
        type: string
      msgsSeen:
        type: array
        items:
          type: string
      notifications:
        type: object
        properties: {}
      optionsBeta:
        type: boolean
      orderBookBinning:
        type: object
        properties: {}
      orderBookType:
        type: string
      orderClearImmediate:
        type: boolean
        default: false
      orderControlsPlusMinus:
        type: boolean
      platformLayout:
        type: string
      selectedFiatCurrency:
        type: string
      showChartBottomToolbar:
        type: boolean
      showLocaleNumbers:
        type: boolean
        default: true
      sounds:
        type: array
        items:
          type: string
      spacingPreference:
        type: string
      strictIPCheck:
        type: boolean
        default: false
      strictTimeout:
        type: boolean
        default: true
      tickerGroup:
        type: string
      tickerPinned:
        type: boolean
      tradeLayout:
        type: string
      userColor:
        type: string
  AssetsConfigNetworkItem:
    type: object
    required:
    - asset
    properties:
      asset:
        type: string
        default: BTC
      tokenAddress:
        type: string
        default: ""
      depositEnabled:
        type: boolean
        default: true
      withdrawalEnabled:
        type: boolean
        default: true
      withdrawalFee:
        type: number
        format: double
      minFee:
        type: number
        format: double
      maxFee:
        type: number
        format: double
  inline_response_200:
    type: object
    properties:
      name:
        type: string
  Error_error:
    type: object
    properties:
      message:
        type: string
      name:
        type: string