documentation.yaml

toc:
  - name: Clients
    children:
      - name: REST Public Client
        description: |
          ```typescript
            import { RestPublicClient } from '@idexio/idex-sdk';
          ```
        children:
          - RestPublicClient
          - RestPublicClientOptions
      - name: REST Authenticated Client
        description: |
          ```typescript
            import { RestAuthenticatedClient } from '@idexio/idex-sdk';
          ```
        children:
          - RestAuthenticatedClient
          - RestAuthenticatedClientOptions
      - name: WebSocketClient
        description: |
          ```typescript
            import { WebSocketClient } from '@idexio/idex-sdk';
          ```
        children:
          - WebSocketClient
          - WebSocketClientOptions
      - name: OrderBookRealTimeClient
        description: |
          ```typescript
            import { OrderBookRealTimeClient } from '@idexio/idex-sdk';
          ```
        children:
          - OrderBookRealTimeClient
          - OrderBookRealTimeClientOptions
  - name: Enums
    description: |
      Sets of named constants used as field types for several requests and responses
    children:
      - CandleInterval
      - EthTransactionStatus
      - Liquidity
      - MarketStatus
      - OrderSelfTradePrevention
      - OrderSide
      - OrderStateChange
      - OrderStatus
      - OrderTimeInForce
      - OrderType
  - name: REST Requests
    children:
      - RestRequestCancelOrders
      - RestRequestFindBalances
      - RestRequestFindCandles
      - RestRequestFindDeposit
      - RestRequestFindDeposits
      - RestRequestFindFill
      - RestRequestFindFills
      - RestRequestFindMarkets
      - RestRequestFindOrder
      - RestRequestFindOrders
      - RestRequestFindTrades
      - RestRequestFindWithdrawal
      - RestRequestFindWithdrawals
      - RestRequestOrder
      - RestRequestWithdrawal
      - RestRequestAssociateWallet
  - name: REST Responses
    children:
      - RestResponseAsset
      - RestResponseBalance
      - RestResponseCandle
      - RestResponseDeposit
      - RestResponseExchangeInfo
      - RestResponseFill
      - RestResponseMarket
      - RestResponseOrder
      - RestResponseCanceledOrder
      - RestResponseOrderBookLevel1
      - RestResponseOrderBookLevel2
      - RestResponseOrderBookPriceLevel
      - RestResponseOrderFill
      - RestResponsePing
      - RestResponseTicker
      - RestResponseTime
      - RestResponseTrade
      - RestResponseUser
      - RestResponseWallet
      - RestResponseWebSocketToken
      - RestResponseWithdrawal
      - RestResponseAssociateWallet
  - name: WebSocket Subscriptions
    children:
      - AuthTokenWebSocketRequestOrdersSubscription
      - AuthTokenWebSocketRequestBalancesSubscription
      - WebSocketRequestTickersSubscription
      - WebSocketRequestCandlesSubscription
      - WebSocketRequestTradesSubscription
      - WebSocketRequestL1OrderBookSubscription
      - WebSocketRequestL2OrderBookSubscription
      - WebSocketRequestBalancesSubscription
      - WebSocketRequestOrdersSubscription
  - name: WebSocket Responses
    children:
      - WebSocketResponseError
      - WebSocketResponseSubscriptions
      - WebSocketResponseTickerShort
      - WebSocketResponseTickerLong
      - WebSocketResponseCandleShort
      - WebSocketResponseCandleLong
      - WebSocketResponseTradeShort
      - WebSocketResponseTradeLong
      - WebSocketResponseL1OrderBookShort
      - WebSocketResponseL1OrderBookLong
      - WebSocketResponseL2OrderBookShort
      - WebSocketResponseL2OrderBookLong
      - WebSocketResponseBalanceShort
      - WebSocketResponseBalanceLong
      - WebSocketResponseOrderShort
      - WebSocketResponseOrderLong
      - WebSocketResponseOrderFillShort
  - name: Type Guards
    description: |
        [Type Guards](https://www.typescriptlang.org/docs/handbook/advanced-types.html#user-defined-type-guards)
        are mostly useful for TypeScript users and can be used to refine general types when needing to parse or
        build the required values.
    children:
      - isWebSocketAuthenticatedSubscription
      - isWebSocketUnauthenticatedSubscription
      - isWebSocketCandlesSubscription
      - isWebSocketLooseSubscription
      - isCandleInterval
  - name: ECDSA Signatures
    children:
      - MessageSigner
      - createAssociateWalletSignature


  - name: Misc Types & Utilities
    children:
      - ErrorShortCodes