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

# Get open positions

> Returns open positions for your Firm, or for every Firm under your FCM. Requires a FIRM- or FCM-level API key.



## OpenAPI

````yaml /api-reference/derivatives-predictions-api/rest-api/cpm-spec.json get /api/positions
openapi: 3.0.3
info:
  title: CPM Public REST API
  version: 0.1.0
servers:
  - url: https://api.example.com
    variables: {}
security:
  - auth_api_key: []
  - auth_timestamp: []
  - auth_passphrase: []
  - auth_signature: []
paths:
  /api/positions:
    get:
      tags:
        - Positions
      summary: Get open positions
      description: >-
        Returns open positions for your Firm, or for every Firm under your FCM.
        Requires a FIRM- or FCM-level API key.
      operationId: getPositions
      parameters:
        - name: instrument_id
          in: query
          description: Filter by instrument ID.
          required: false
          deprecated: false
          allowEmptyValue: false
          schema:
            type: string
        - name: sub_account
          in: query
          description: Filter by sub-account.
          required: false
          deprecated: false
          allowEmptyValue: false
          schema:
            type: string
        - name: limit
          in: query
          description: >-
            Maximum number of positions per page. Default 100; must be 1 to 500,
            otherwise 400.
          required: false
          deprecated: false
          allowEmptyValue: false
          schema:
            type: string
        - name: cursor
          in: query
          description: >-
            Opaque cursor from the previous page's cursor field. Omit on the
            first request.
          required: false
          deprecated: false
          allowEmptyValue: false
          schema:
            type: string
      responses:
        '200':
          description: Positions page
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PositionResponse'
                  cursor:
                    type: string
      deprecated: false
      security: []
components:
  schemas:
    PositionResponse:
      type: object
      additionalProperties: false
      properties:
        firm_id:
          type: string
          description: >-
            Id of the firm that owns the position, as a canonical decimal
            string.
          example: '298471892342'
        instrument_id:
          type: string
          description: Instrument id, as a canonical decimal string.
          example: '598471892347'
        ticker:
          type: string
          description: Instrument ticker.
          example: NFL-GAMEWINNER-26NOV28LARSF-LAR
        sub_account:
          type: string
          description: Sub-account that holds the position.
          example: fund-a
        quantity:
          type: string
          description: >-
            Net position in contracts, as a signed decimal string. Positive is
            long YES; negative is short YES.
          example: '10.00'
  securitySchemes:
    auth_api_key:
      name: CB-ACCESS-KEY
      description: The API key string for the request
      in: header
      type: apiKey
    auth_timestamp:
      name: CB-ACCESS-TIMESTAMP
      description: The request timestamp (epoch seconds)
      in: header
      type: apiKey
    auth_passphrase:
      name: CB-ACCESS-PASSPHRASE
      description: The passphrase for the API key
      in: header
      type: apiKey
    auth_signature:
      name: CB-ACCESS-SIGN
      description: HMAC SHA-256 signature over TIMESTAMP + METHOD + REQUEST_PATH + BODY
      in: header
      type: apiKey

````