openapi: 3.0.0
info:
  title: '@gmx-io/gmx-public-api Allowances Orders API'
  version: 1.0.0
  license:
    name: Copyright
  contact: {}
servers:
- url: /v1
tags:
- name: Orders
paths:
  /orders:
    get:
      operationId: GetOrdersByAddress
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/OrderResponse'
                type: array
        '400':
          description: Bad Request - Invalid address
        '500':
          description: Internal Server Error
      tags:
      - Orders
      security: []
      parameters:
      - in: query
        name: address
        required: true
        schema:
          type: string
  /orders/{key}:
    get:
      operationId: GetOrderByKey
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderResponse'
        '400':
          description: Bad Request - Invalid key
        '404':
          description: Order not found
        '500':
          description: Internal Server Error
      tags:
      - Orders
      security: []
      parameters:
      - in: path
        name: key
        required: true
        schema:
          type: string
components:
  schemas:
    OrderResponse:
      properties:
        requestId:
          type: string
          nullable: true
        dataList:
          items:
            type: string
          type: array
        autoCancel:
          type: boolean
        isFrozen:
          type: boolean
        shouldUnwrapNativeToken:
          type: boolean
        isLong:
          type: boolean
        srcChainId:
          type: string
        validFromTime:
          type: string
        updatedAtTime:
          type: string
        minOutputAmount:
          type: string
        callbackGasLimit:
          type: string
        executionFee:
          type: string
        acceptablePrice:
          type: string
        triggerPrice:
          type: string
        initialCollateralDeltaAmount:
          type: string
        sizeDeltaUsd:
          type: string
        decreasePositionSwapType:
          type: number
          format: double
        orderType:
          type: number
          format: double
        swapPath:
          items:
            type: string
          type: array
        initialCollateralTokenAddress:
          type: string
        marketAddress:
          type: string
        uiFeeReceiver:
          type: string
        callbackContract:
          type: string
        cancellationReceiver:
          type: string
        receiver:
          type: string
        account:
          type: string
        key:
          type: string
      required:
      - requestId
      - dataList
      - autoCancel
      - isFrozen
      - shouldUnwrapNativeToken
      - isLong
      - srcChainId
      - validFromTime
      - updatedAtTime
      - minOutputAmount
      - callbackGasLimit
      - executionFee
      - acceptablePrice
      - triggerPrice
      - initialCollateralDeltaAmount
      - sizeDeltaUsd
      - decreasePositionSwapType
      - orderType
      - swapPath
      - initialCollateralTokenAddress
      - marketAddress
      - uiFeeReceiver
      - callbackContract
      - cancellationReceiver
      - receiver
      - account
      - key
      type: object