Ondo Finance

Ondo Finance Stop Orders API

The Stop Orders API from Ondo Finance — 1 operation(s) for stop orders.

GitHub OpenAPI

Documentation

📖
Quickstart
https://docs.ondo.finance/api-reference/quickstart

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/ondo-finance/refs/heads/main/openapi/ondo-finance-stop-orders-api-openapi.yml

Other Resources

🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/ondo-finance/refs/heads/main/grpc/ondo-finance-gm-backend.proto
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/ondo-finance/refs/heads/main/errors/ondo-finance-error-codes.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/ondo-finance/refs/heads/main/openapi/ondo-finance-perps-ws-openapi-original.json

OpenAPI Specification

ondo-finance-stop-orders-api-openapi.yml Raw ↑ 
openapi: 3.0.4
info:
  title: GM Backend Account Stop Orders API
  description: An API spec for the Ondo GM Backend API.
  version: 1.0.0
servers:
- url: https://api.gm.ondo.finance
  description: GM Backend API
tags:
- name: Stop Orders
paths:
  /v1/perps/stop_order:
    get:
      summary: Get Stop Orders
      description: Gets a list of all stop orders for all markets.
      operationId: getStopOrders
      tags:
      - Stop Orders
      security:
      - BearerAuth: []
      - ApiKeyAuth: []
      responses:
        '200':
          description: Map of market to stop orders
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/GenericResponse'
                - type: object
                  properties:
                    result:
                      type: object
                      additionalProperties:
                        $ref: '#/components/schemas/ApiStopOrders'
              example:
                success: true
                result:
                  AAPL-USD.P:
                    market: AAPL-USD.P
                    positionDirection: long
                    stopLoss: '200.00'
                    takeProfit: '260.00'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
    post:
      summary: Set Stop Order
      description: Set a stop order for a particular position defined by market and direction.
      operationId: setStopOrder
      tags:
      - Stop Orders
      security:
      - BearerAuth: []
      - ApiKeyAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetStopOrderReq'
      responses:
        '200':
          description: Updated stop orders for the market
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/GenericResponse'
                - type: object
                  properties:
                    result:
                      $ref: '#/components/schemas/ApiStopOrders'
              example:
                success: true
                result:
                  market: AAPL-USD.P
                  positionDirection: long
                  stopLoss: '200.00'
                  takeProfit: null
        '400':
          description: Bad request. The request was malformed or failed validation.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  error:
                    type: string
                    description: Human-readable error message
                  error_code:
                    type: string
                    enum:
                    - invalid_market
                    - invalid_stop_order
                    - order_invalid_price
                    - price_over_ui_limit_10MM
                    - stop_order_crosses_mark_price
                    - stop_order_crosses_order_price
                    - stop_order_trigger_price_exceeds_max
                    - stop_order_trigger_price_invalid_increment
                    - stop_order_trigger_price_negative
                    - trading_disabled
              example:
                success: false
                error: Description of the error
                error_code: invalid_market
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
    delete:
      summary: Remove Stop Order
      description: Remove a stop order. If no type is specified, removes both stop loss and take profit.
      operationId: removeStopOrder
      tags:
      - Stop Orders
      security:
      - BearerAuth: []
      - ApiKeyAuth: []
      parameters:
      - name: market
        in: query
        description: Perps market
        required: true
        schema:
          type: string
          example: AAPL-USD.P
      - name: type
        in: query
        description: 'The type of stop order to remove. Either "stopLoss" or "takeProfit". If not set, removes both stop loss and take profit orders.

          '
        required: false
        schema:
          type: string
          enum:
          - stopLoss
          - takeProfit
          example: stopLoss
      responses:
        '200':
          description: Remaining stop orders for the market after removal
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/GenericResponse'
                - type: object
                  properties:
                    result:
                      $ref: '#/components/schemas/ApiStopOrders'
              example:
                success: true
                result:
                  market: AAPL-USD.P
                  positionDirection: long
                  stopLoss: null
                  takeProfit: null
        '400':
          description: Bad request. The request was malformed or failed validation.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  error:
                    type: string
                    description: Human-readable error message
                  error_code:
                    type: string
                    enum:
                    - bad_query_param
                    - invalid_market
                    - trading_disabled
              example:
                success: false
                error: Description of the error
                error_code: bad_query_param
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  responses:
    Forbidden:
      description: Access denied. The authenticated account does not have permission.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              error:
                type: string
                description: Human-readable error message
              error_code:
                type: string
                enum:
                - account_closed
                - account_not_allowed
                - forbidden
                - ip_not_permitted
                - key_doesnt_have_scope
          example:
            success: false
            error: Description of the error
            error_code: account_not_allowed
    TooManyRequests:
      description: Rate limit exceeded. Slow down request frequency.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              error:
                type: string
                description: Human-readable error message
              error_code:
                type: string
                enum:
                - too_many_requests
          example:
            success: false
            error: Description of the error
            error_code: too_many_requests
    Unauthorized:
      description: Authentication required. Provide a valid JWT or API key.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              error:
                type: string
                description: Human-readable error message
              error_code:
                type: string
                enum:
                - api_key_not_found
                - auth_expired
                - auth_invalid
                - auth_missing
                - failed_to_decode_hex_signature
                - failed_to_parse_timestamp
                - signature_mismatch
                - timestamp_too_far
          example:
            success: false
            error: Description of the error
            error_code: auth_missing
    InternalServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              error:
                type: string
                description: Human-readable error message
              error_code:
                type: string
                enum:
                - server_is_busy
                - service_unavailable
                - unknown
          example:
            success: false
            error: Description of the error
            error_code: unknown
  schemas:
    SetStopOrderReq:
      type: object
      required:
      - market
      - positionDirection
      - type
      - triggerPrice
      properties:
        market:
          type: string
          description: Perps market
          example: AAPL-USD.P
        positionDirection:
          type: string
          description: Position direction this stop order watches
          enum:
          - long
          - short
          example: long
        type:
          type: string
          description: The type of stop order to set
          enum:
          - stopLoss
          - takeProfit
          example: stopLoss
        triggerPrice:
          type: string
          description: The trigger price
          example: '9.00'
    ApiStopOrders:
      type: object
      required:
      - market
      - positionDirection
      properties:
        market:
          type: string
          description: Perps market
          example: AAPL-USD.P
        positionDirection:
          type: string
          description: Position direction this stop order watches
          enum:
          - long
          - short
          - neutral
          example: long
        stopLoss:
          type: string
          nullable: true
          description: Stop loss trigger price, if set
          example: '8.00'
        takeProfit:
          type: string
          nullable: true
          description: Take profit trigger price, if set
          example: null
    GenericResponse:
      type: object
      required:
      - success
      properties:
        success:
          type: boolean
          description: Whether the request was successful
          example: true
        error:
          type: string
          description: Error message, present only on failure
          example: ''
        error_code:
          type: string
          description: Semantic error code. See each endpoint's error responses for the specific codes it can return.
        deprecated:
          type: string
          description: Deprecation notice, if applicable
          example: ''
  securitySchemes:
    apiKey:
      type: apiKey
      name: x-api-key
      in: header