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

# Get a stop loss

> One stop loss or take profit of this key’s trading account by id.



## OpenAPI

````yaml api-reference/openapi.json GET /stop-losses/{id}
openapi: 3.0.0
info:
  title: Lean API
  version: 0.1.0
  description: >-
    Programmatic access to Lean: canonical sports markets, quotes, orders,
    positions and balances.
servers:
  - url: '{baseUrl}/v1'
    description: Lean API
    variables:
      baseUrl:
        default: https://api.lean.xyz
        description: >-
          The Lean API base URL, without /v1. Same value as LEAN_API_URL in the
          guides.
security:
  - apiKey: []
paths:
  /stop-losses/{id}:
    get:
      tags:
        - Stop losses
      summary: Get a stop loss
      description: One stop loss or take profit of this key’s trading account by id.
      operationId: getStopLoss
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 64
            example: 3c9d2e71-5a4b-4f08-b6e2-91d7c0a4f5e3
          required: true
          name: id
          in: path
      responses:
        '200':
          description: The stop loss
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      success:
                        type: boolean
                        enum:
                          - true
                      data:
                        type: object
                        properties:
                          id:
                            type: string
                            minLength: 1
                          market_id:
                            type: string
                            nullable: true
                            minLength: 1
                          venue:
                            type: string
                            enum:
                              - kalshi
                              - polymarket
                              - polymarket_us
                              - hyperliquid
                          ticker:
                            type: string
                            minLength: 1
                          side:
                            type: string
                            enum:
                              - 'yes'
                              - 'no'
                          type:
                            type: string
                            enum:
                              - stop_loss
                              - take_profit
                          trigger_price:
                            type: string
                          quantity:
                            type: string
                            pattern: ^\d+(?:\.\d+)?$
                          slippage_limit:
                            type: string
                          status:
                            type: string
                            enum:
                              - active
                              - triggered
                              - executing
                              - filled
                              - partial
                              - canceled
                              - expired
                              - failed
                          triggered_at:
                            type: string
                            nullable: true
                            format: date-time
                          triggered_price:
                            type: string
                            nullable: true
                          filled_quantity:
                            type: string
                            pattern: ^\d+(?:\.\d+)?$
                          avg_fill_price:
                            type: string
                            nullable: true
                          expires_at:
                            type: string
                            nullable: true
                            format: date-time
                          cancel_requested_at:
                            type: string
                            nullable: true
                            format: date-time
                            description: >-
                              When a cancel was asked for, or null. A live stop
                              loss keeps its status until Lean applies the
                              cancel a moment later, then reads canceled.
                          created_at:
                            type: string
                            format: date-time
                          updated_at:
                            type: string
                            format: date-time
                          livemode:
                            type: boolean
                        required:
                          - id
                          - market_id
                          - venue
                          - ticker
                          - side
                          - type
                          - trigger_price
                          - quantity
                          - slippage_limit
                          - status
                          - triggered_at
                          - triggered_price
                          - filled_quantity
                          - avg_fill_price
                          - expires_at
                          - cancel_requested_at
                          - created_at
                          - updated_at
                          - livemode
                      meta:
                        type: object
                        properties:
                          timestampMs:
                            type: integer
                            minimum: 0
                          requestId:
                            type: string
                            minLength: 1
                          traceId:
                            type: string
                            minLength: 1
                          cachedAtMs:
                            type: integer
                            minimum: 0
                          source:
                            type: string
                            enum:
                              - cache
                              - database
                              - clickhouse
                              - upstream
                              - fallback
                              - internal
                        required:
                          - timestampMs
                          - requestId
                    required:
                      - success
                      - data
                      - meta
                  - $ref: '#/components/schemas/ApiError'
              example:
                success: true
                data:
                  id: 3c9d2e71-5a4b-4f08-b6e2-91d7c0a4f5e3
                  market_id: >-
                    mkt_bmZsOjIwMjYtMTAtMTE6REVOLUxBQwpzcHJlYWQ6Z2FtZTpERU46LTMuNQpERU4
                  venue: polymarket
                  ticker: >-
                    pm:0x2222222222222222222222222222222222222222222222222222222222222222
                  side: 'yes'
                  type: stop_loss
                  trigger_price: '0.4'
                  quantity: '25'
                  slippage_limit: '0.05'
                  status: active
                  triggered_at: null
                  triggered_price: null
                  filled_quantity: '0'
                  avg_fill_price: null
                  expires_at: null
                  cancel_requested_at: null
                  created_at: '2026-11-10T15:00:00.000Z'
                  updated_at: '2026-11-10T15:00:00.000Z'
                  livemode: false
                meta:
                  timestampMs: 1792771200000
                  requestId: 7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17
        '400':
          description: API error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: VALIDATION_ERROR
                  message: Invalid request
                meta:
                  timestampMs: 1792771200000
                  requestId: 7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17
        '401':
          description: Missing, invalid, expired or revoked API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: UNAUTHORIZED
                  message: Invalid, expired or revoked API key
                meta:
                  timestampMs: 1792771200000
                  requestId: 7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17
        '403':
          description: The key lacks the scope this route needs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: FORBIDDEN
                  message: This API key lacks the scope this route needs
                meta:
                  timestampMs: 1792771200000
                  requestId: 7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17
        '404':
          description: API error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: NOT_FOUND
                  message: Not found
                meta:
                  timestampMs: 1792771200000
                  requestId: 7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17
        '429':
          description: API error
          headers:
            Retry-After:
              description: Seconds remaining in the upstream read cooldown, when available
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: RATE_LIMITED
                  message: Too many requests for this API key
                meta:
                  timestampMs: 1792771200000
                  requestId: 7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17
        '500':
          description: API error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                success: false
                error:
                  code: INTERNAL_ERROR
                  message: An internal error occurred.
                meta:
                  timestampMs: 1792771200000
                  requestId: 7d2c9f4e-1b3a-4e8d-9c6f-2a5b8e0d4f17
components:
  schemas:
    ApiError:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - VALIDATION_ERROR
                - NOT_FOUND
                - UNAUTHORIZED
                - FORBIDDEN
                - CONFLICT
                - UPSTREAM_ERROR
                - RATE_LIMITED
                - INTERNAL_ERROR
                - FEATURE_DISABLED
                - CONDITIONAL_SELL_REJECTED
                - CONDITIONAL_SELL_ACTIVE
            message:
              type: string
              minLength: 1
            details:
              nullable: true
          required:
            - code
            - message
        meta:
          type: object
          properties:
            timestampMs:
              type: integer
              minimum: 0
            requestId:
              type: string
              minLength: 1
            traceId:
              type: string
              minLength: 1
            cachedAtMs:
              type: integer
              minimum: 0
            source:
              type: string
              enum:
                - cache
                - database
                - clickhouse
                - upstream
                - fallback
                - internal
          required:
            - timestampMs
            - requestId
      required:
        - success
        - error
        - meta
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A Lean API key, sent as `Authorization: Bearer <key>`. A test key
        (`lean_sk_test_...`) simulates orders and fills with no money; a live
        key (`lean_sk_live_...`) trades for real within the key's limits. Every
        successful response says which mode answered in `data.livemode`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.