> ## Documentation Index
> Fetch the complete documentation index at: https://developer.woox.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get algo orders

> get algo orders

**Limit: 10 requests per 1 second**\
Get orders by customizable conditions.  For filtering by status, one can reference special bundled statuses below for ease of access of open (i.e. INCOMPLETE) orders or COMPLETED orders.

INCOMPLETE = NEW + PARTIAL\_FILLED

COMPLETED = CANCELLED + FILLED + REJECTED

<ResponseExample>
  ```bash theme={null}
  {
      {
      "success": true,
      "data": {
          "meta": {
              "total": 2,
              "recordsPerPage": 25,
              "currentPage": 1
          },
          "rows": [
              {
                  "algoOrderId": 792419,
                  "clientAlgoOrderId": 0,
                  "rootAlgoOrderId": 792419,
                  "parentAlgoOrderId": 0,
                  "symbol": "SPOT_WOO_USDT",
                  "algoOrderTag": "default",
                  "algoType": "TRAILING_STOP",
                  "side": "SELL",
                  "positionSide": "BOTH",
                  "quantity": 1,
                  "isTriggered": false,
                  "triggerStatus": "USELESS",
                  "type": "MARKET",
                  "rootAlgoStatus": "NEW",
                  "algoStatus": "NEW",
                  "triggerPriceType": "MARKET_PRICE",
                  "triggerTime": "0",
                  "totalExecutedQuantity": "0",
                  "averageExecutedPrice": "0",
                  "totalFee": "0",
                  "feeAsset": "",
                  "totalRebate": 0,
                  "rebateCurrency": "USDT",
                  "reduceOnly": false,
                  "createdTime": 1696595221136,
                  "updatedTime": 1696595221136,
                  "isActivated": false,
                  "callbackRate": "0.03",
                  "activatedPrice": "0.21"
              },
              {
                  "algoOrderId": 792407,
                  "clientAlgoOrderId": 0,
                  "rootAlgoOrderId": 792407,
                  "parentAlgoOrderId": 0,
                  "symbol": "SPOT_WOO_USDT",
                  "algoOrderTag": "default",
                  "algoType": "BRACKET",
                  "side": "BUY",
                  "quantity": "100",
                  "isTriggered": false,
                  "triggerStatus": "SUCCESS",
                  "type": "LIMIT",
                  "positionSide": "BOTH",
                  "status": "NEW",
                  "rootAlgoStatus": "NEW",
                  "algoStatus": "NEW",
                  "triggerPriceType": "MARKET_PRICE",
                  "price": "0.15",
                  "triggerTime": "0",
                  "totalExecutedQuantity": "0",
                  "averageExecutedPrice": "0",
                  "totalFee": "0",
                  "feeAsset": "WOO",
                  "totalRebate": 0,
                  "rebateCurrency": "USDT",
                  "reduceOnly": false,
                  "createdTime": 1696589756133,
                  "updatedTime": 1696589756247,
                  "childOrders": [
                      {
                          "algoOrderId": 792408,
                          "clientAlgoOrderId": 0,
                          "rootAlgoOrderId": 792407,
                          "parentAlgoOrderId": 792407,
                          "symbol": "SPOT_WOO_USDT",
                          "algoOrderTag": "default",
                          "algoType": "TP_SL",
                          "side": "SELL",
                          "positionSide": "BOTH",
                          "quantity": 0,
                          "isTriggered": false,
                          "triggerStatus": "USELESS",
                          "rootAlgoStatus": "NEW",
                          "algoStatus": "NEW",
                          "triggerPriceType": "MARKET_PRICE",
                          "triggerTime": "0",
                          "totalExecutedQuantity": "0",
                          "visibleQuantity": "0",
                          "averageExecutedPrice": "0",
                          "totalFee": "0",
                          "feeAsset": "",
                          "totalRebate": "0",
                          "rebateCurrency": "USDT",
                          "reduceOnly": false,
                          "createdTime": 1696589756128,
                          "updatedTime": 1696589756128,
                          "isActivated": false,
                          "childOrders": [
                              {
                                  "algoOrderId": 792409,
                                  "clientAlgoOrderId": 0,
                                  "rootAlgoOrderId": 792407,
                                  "parentAlgoOrderId": 792408,
                                  "symbol": "SPOT_WOO_USDT",
                                  "algoOrderTag": "default",
                                  "algoType": "TAKE_PROFIT",
                                  "side": "SELL",
                                  "positionSide": "BOTH",
                                  "quantity": "0",
                                  "isTriggered": false,
                                  "triggerPrice": "0.3",
                                  "triggerStatus": "USELESS",
                                  "type": "MARKET",
                                  "rootAlgoStatus": "NEW",
                                  "algoStatus": "NEW",
                                  "triggerPriceType": "MARKET_PRICE",
                                  "triggerTime": "0",
                                  "totalExecutedQuantity": "0",
                                  "visibleQuantity": "0",
                                  "averageExecutedPrice": "0",
                                  "totalFee": "0",
                                  "feeAsset": "",
                                  "totalRebate": "0",
                                  "rebateCurrency": "USDT",
                                  "reduceOnly": true,
                                  "createdTime": 1696589756118,
                                  "updatedTime": 1696589756118,
                                  "isActivated": false
                              },
                              {
                                  "algoOrderId": 792410,
                                  "clientAlgoOrderId": 0,
                                  "rootAlgoOrderId": 792407,
                                  "parentAlgoOrderId": 792408,
                                  "symbol": "SPOT_WOO_USDT",
                                  "algoOrderTag": "default",
                                  "algoType": "STOP_LOSS",
                                  "side": "SELL",
                                  "positionSide": "BOTH",
                                  "quantity": 0,
                                  "isTriggered": false,
                                  "triggerPrice": "0.1",
                                  "triggerStatus": "USELESS",
                                  "type": "MARKET",
                                  "rootAlgoStatus": "NEW",
                                  "algoStatus": "NEW",
                                  "triggerPriceType": "MARKET_PRICE",
                                  "triggerTime": "0",
                                  "totalExecutedQuantity": "0",
                                  "visibleQuantity": "0",
                                  "averageExecutedPrice": "0",
                                  "totalFee": "0",
                                  "feeAsset": "",
                                  "totalRebate": "0",
                                  "rebateCurrency": "USDT",
                                  "reduceOnly": true,
                                  "createdTime": 1696589756123,
                                  "updatedTime": 1696589756123,
                                  "isActivated": false
                              }
                          ]
                      }
                  ]
              },
              ...
          ]
      },
      "timestamp": 1696598461952
  }
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /v3/trade/algoOrders
openapi: 3.0.2
info:
  title: Swagger Petstore - OpenAPI 3.0
  description: >-
    This is a sample Pet Store Server based on the OpenAPI 3.0 specification. 
    You can find out more about

    Swagger at [http://swagger.io](http://swagger.io). In the third iteration of
    the pet store, we've switched to the design first approach!

    You can now help us improve the API whether it's by making changes to the
    definition itself or to the code.

    That way, with time, we can improve the API in general, and expose some of
    the new features in OAS3.


    Some useful links:

    - [The Pet Store
    repository](https://github.com/swagger-api/swagger-petstore)

    - [The source API definition for the Pet
    Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)
  termsOfService: http://swagger.io/terms/
  contact:
    name: API Team
    email: apiteam@swagger.io
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.19
servers:
  - url: https://api.woox.io/
security: []
externalDocs:
  description: Find out more about Swagger
  url: http://swagger.io
paths:
  /v3/trade/algoOrders:
    get:
      description: get algo orders
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
            example: abcdef123456
          description: ''
        - name: x-api-signature
          in: header
          required: true
          schema:
            type: string
            example: signaturestring
          description: ''
        - name: x-api-timestamp
          in: header
          required: true
          schema:
            type: string
            example: '1718943200000'
          description: ''
        - name: symbol
          in: query
          description: Symbol name
          required: false
          explode: true
          schema:
            type: string
        - name: side
          in: query
          description: BUY/SELL
          required: false
          explode: true
          schema:
            type: string
        - name: positionSide
          in: query
          description: >-
            BOTH for one way mode; LONG or SHORT for hedge mode; Only applicable
            to perpetual instruments
          required: false
          explode: true
          schema:
            type: string
        - name: algoType
          in: query
          description: STOP/OCO/TRAILING_STOP/POSITIONAL_TP_SL/TP_SL/BRACKET/STOP_BRACKET
          required: false
          explode: true
          schema:
            type: string
        - name: orderType
          in: query
          description: LIMIT/MARKET
          required: false
          explode: true
          schema:
            type: string
        - name: isTriggered
          in: query
          description: true/false
          required: false
          explode: true
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
        - name: algoOrderTag
          in: query
          description: Order tag
          required: false
          explode: true
          schema:
            type: string
        - name: realizedPnl
          in: query
          description: Whether to return order’s realized pnl
          required: false
          explode: true
          schema:
            type: boolean
        - name: status
          in: query
          description: NEW/CANCELLED/PARTIAL_FILLED/FILLED/REJECTED/INCOMPLETE/COMPLETED
          required: false
          explode: true
          schema:
            type: string
        - name: startTime
          in: query
          description: Start timestamp in Unix timestamp format in milliseconds
          required: false
          explode: true
          schema:
            type: integer
            format: int64
        - name: endTime
          in: query
          description: End timestamp in Unix timestamp format in milliseconds
          required: false
          explode: true
          schema:
            type: integer
            format: int64
        - name: page
          in: query
          description: Page number
          required: false
          explode: true
          schema:
            type: integer
            default: 1
        - name: size
          in: query
          description: Data size per page, max 500
          required: false
          explode: true
          schema:
            type: integer
            default: 50
            maximum: 500
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAlgoOrdersResponse'
      security: []
components:
  schemas:
    GetAlgoOrdersResponse:
      allOf:
        - $ref: '#/components/schemas/CommonResponse'
        - type: object
          properties:
            data:
              type: object
              properties:
                rows:
                  type: array
                  items:
                    $ref: '#/components/schemas/GetAlgoOrderRowResponse'
                  description: ''
                meta:
                  $ref: '#/components/schemas/Meta'
    CommonResponse:
      type: object
      properties:
        success:
          type: boolean
          description: 'true'
        timestamp:
          type: integer
          description: timestamp
    GetAlgoOrderRowResponse:
      type: object
      properties:
        algoOrderId:
          type: integer
          description: Unique identifier for the algorithmic order.
        clientAlgoOrderId:
          type: integer
          description: Client-generated unique identifier for the algorithmic order.
        rootAlgoOrderId:
          type: integer
          description: Root algorithmic order ID, linking to the original order.
        parentAlgoOrderId:
          type: integer
          description: Parent algorithmic order ID, 0 if there is no parent order.
        symbol:
          type: string
          description: Trading pair symbol, e.g., SPOT_WOO_USDT.
        algoOrderTag:
          type: string
          description: Tag associated with the algorithmic order, e.g., 'default'.
        algoType:
          type: string
          description: Type of algorithmic order, e.g., TRAILING_STOP.
          enum:
            - STOP
            - OCO
            - TRAILING_STOP
            - POSITIONAL_TP_SL
            - TP_SL
            - BRACKET
            - STOP_BRACKET
        side:
          type: string
          description: Trade direction, e.g., SELL indicates selling.
          enum:
            - BUY
            - SELL
        positionSide:
          type: string
          description: Position side, e.g., BOTH indicates a dual position mode.
          enum:
            - BOTH
            - LONG
            - SHORT
        quantity:
          type: integer
          description: Quantity for the algorithmic order.
        isTriggered:
          type: boolean
          description: Indicates whether the order has been triggered.
        triggerStatus:
          type: string
          description: Trigger status of the order, e.g., USELESS.
          enum:
            - USELESS
            - TRIGGERED
            - CANCELLED
        type:
          type: string
          description: Order type, e.g., MARKET.
          enum:
            - LIMIT
            - MARKET
            - IOC
            - POST_ONLY
            - AC
            - FOK
            - LIQUIDATE
            - BID
            - ASK
            - RPI
        rootAlgoStatus:
          type: string
          description: Status of the root algorithmic order, e.g., NEW.
          enum:
            - NEW
            - CANCELLED
            - PARTIAL_FILLED
            - FILLED
            - REJECTED
        algoStatus:
          type: string
          description: Status of the algorithmic order, e.g., NEW.
          enum:
            - NEW
            - CANCELLED
            - PARTIAL_FILLED
            - FILLED
            - REJECTED
        triggerPriceType:
          type: string
          description: Price type used for triggering, e.g., MARKET_PRICE.
          enum:
            - MARKET_PRICE
            - INDEX_PRICE
            - LAST_PRICE
        triggerTime:
          type: string
          description: Timestamp when the order was triggered, '0' if not triggered.
        totalExecutedQuantity:
          type: string
          description: Total executed quantity for the order.
        averageExecutedPrice:
          type: string
          description: Average price of the executed quantity.
        totalFee:
          type: string
          description: Total fee charged for the algorithmic order.
        feeAsset:
          type: string
          description: Asset type used for paying fees, e.g., USDT.
        totalRebate:
          type: number
          description: Total rebate received for the order.
        rebateCurrency:
          type: string
          description: Currency in which the rebate is paid, e.g., USDT.
        reduceOnly:
          type: boolean
          description: Indicates whether the order is reduce-only.
        createdTime:
          type: integer
          format: int64
          description: Timestamp when the order was created (in milliseconds).
        updatedTime:
          type: integer
          format: int64
          description: Timestamp when the order was last updated (in milliseconds).
        isActivated:
          type: boolean
          description: Indicates whether the algorithmic order is activated.
        callbackRate:
          type: string
          description: Callback rate for the algorithmic order.
        activatedPrice:
          type: string
          description: Activated price for the algorithmic order.
        leverage:
          type: integer
          example: 10
          description: ''
        marginMode:
          type: string
          example: ''
          description: ''
          enum:
            - ISOLATED
            - CROSSED
    Meta:
      type: object
      properties:
        total:
          type: integer
          description: Total number of record
        recordsPerPage:
          type: integer
          description: Number of records per page
        currentPage:
          type: integer
          description: Current page number

````