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

# Get the realised PnL

> Settled bets over a window on their settlement time, [from, to). Without `to`, the window ends now; without `from`, it starts 30 days before `to`. At most 366 days.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/pnl
openapi: 3.1.0
info:
  title: Apexium Trading API
  version: '1'
  description: Public API, authenticated with an API key in the x-api-key header.
servers:
  - url: https://api.apexiumbet.com
    description: Production
security:
  - apiKey: []
tags:
  - name: Health
    description: Whether the API is up, without an API key
  - name: Account
    description: The account behind the API key and its balance
  - name: Reference data
    description: OddsPapi sports, tournaments, participants, markets and bookmakers
  - name: Fixtures
    description: 'OddsPapi fixtures: schedule, status, scores'
  - name: Odds
    description: OddsPapi odds, limited to the account's bookmakers
  - name: Betslip
    description: >-
      The price and stake limits of one selection at each of the account's
      bookmakers
  - name: Orders
    description: Preview, place, read and cancel orders
  - name: Bets
    description: The bets your orders were split into
  - name: Positions and PnL
    description: Open exposure and realised results
paths:
  /v1/pnl:
    get:
      tags:
        - Positions and PnL
      summary: Get the realised PnL
      description: >-
        Settled bets over a window on their settlement time, [from, to). Without
        `to`, the window ends now; without `from`, it starts 30 days before
        `to`. At most 366 days.
      parameters:
        - schema:
            format: date-time
            type: string
          in: query
          name: from
          required: false
        - schema:
            format: date-time
            type: string
          in: query
          name: to
          required: false
        - schema:
            default: day
            type: string
            enum:
              - day
              - bookmaker
              - sport
              - tournament
          in: query
          name: groupBy
          required: false
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                required:
                  - groupBy
                  - from
                  - to
                  - rows
                  - totals
                properties:
                  groupBy:
                    type: string
                    enum:
                      - day
                      - bookmaker
                      - sport
                      - tournament
                  from:
                    format: date-time
                    type: string
                  to:
                    format: date-time
                    type: string
                  rows:
                    type: array
                    items:
                      type: object
                      required:
                        - key
                        - settledBets
                        - wins
                        - losses
                        - voids
                        - pushes
                        - staked
                        - betPnl
                        - commission
                        - rebate
                        - netPnl
                      properties:
                        key:
                          description: >-
                            UTC date (YYYY-MM-DD), bookmaker slug, sport id or
                            tournament id; null for bets without a tournament
                          anyOf:
                            - type: string
                            - type: 'null'
                        settledBets:
                          type: integer
                        wins:
                          description: WON and HALF_WON
                          type: integer
                        losses:
                          description: LOST and HALF_LOST
                          type: integer
                        voids:
                          type: integer
                        pushes:
                          type: integer
                        staked:
                          description: Matched stake of the settled bets
                          type: object
                          required:
                            - amount
                            - amountCents
                            - currency
                          properties:
                            amount:
                              pattern: ^-?\d+\.\d{2}$
                              description: Decimal string, two decimals
                              type: string
                            amountCents:
                              description: >-
                                The same amount in integer cents: amount times
                                100
                              type: integer
                            currency:
                              description: ISO 4217 code
                              type: string
                        betPnl:
                          description: The account's result on the bets that won or lost
                          type: object
                          required:
                            - amount
                            - amountCents
                            - currency
                          properties:
                            amount:
                              pattern: ^-?\d+\.\d{2}$
                              description: Decimal string, two decimals
                              type: string
                            amountCents:
                              description: >-
                                The same amount in integer cents: amount times
                                100
                              type: integer
                            currency:
                              description: ISO 4217 code
                              type: string
                        commission:
                          description: Money amount
                          type: object
                          required:
                            - amount
                            - amountCents
                            - currency
                          properties:
                            amount:
                              pattern: ^-?\d+\.\d{2}$
                              description: Decimal string, two decimals
                              type: string
                            amountCents:
                              description: >-
                                The same amount in integer cents: amount times
                                100
                              type: integer
                            currency:
                              description: ISO 4217 code
                              type: string
                        rebate:
                          description: Money amount
                          type: object
                          required:
                            - amount
                            - amountCents
                            - currency
                          properties:
                            amount:
                              pattern: ^-?\d+\.\d{2}$
                              description: Decimal string, two decimals
                              type: string
                            amountCents:
                              description: >-
                                The same amount in integer cents: amount times
                                100
                              type: integer
                            currency:
                              description: ISO 4217 code
                              type: string
                        netPnl:
                          description: betPnl - commission + rebate
                          type: object
                          required:
                            - amount
                            - amountCents
                            - currency
                          properties:
                            amount:
                              pattern: ^-?\d+\.\d{2}$
                              description: Decimal string, two decimals
                              type: string
                            amountCents:
                              description: >-
                                The same amount in integer cents: amount times
                                100
                              type: integer
                            currency:
                              description: ISO 4217 code
                              type: string
                  totals:
                    description: Equal to the dashboard's PnL over the same window
                    type: object
                    required:
                      - settledBets
                      - wins
                      - losses
                      - voids
                      - pushes
                      - staked
                      - betPnl
                      - commission
                      - rebate
                      - netPnl
                    properties:
                      settledBets:
                        type: integer
                      wins:
                        description: WON and HALF_WON
                        type: integer
                      losses:
                        description: LOST and HALF_LOST
                        type: integer
                      voids:
                        type: integer
                      pushes:
                        type: integer
                      staked:
                        description: Matched stake of the settled bets
                        type: object
                        required:
                          - amount
                          - amountCents
                          - currency
                        properties:
                          amount:
                            pattern: ^-?\d+\.\d{2}$
                            description: Decimal string, two decimals
                            type: string
                          amountCents:
                            description: 'The same amount in integer cents: amount times 100'
                            type: integer
                          currency:
                            description: ISO 4217 code
                            type: string
                      betPnl:
                        description: The account's result on the bets that won or lost
                        type: object
                        required:
                          - amount
                          - amountCents
                          - currency
                        properties:
                          amount:
                            pattern: ^-?\d+\.\d{2}$
                            description: Decimal string, two decimals
                            type: string
                          amountCents:
                            description: 'The same amount in integer cents: amount times 100'
                            type: integer
                          currency:
                            description: ISO 4217 code
                            type: string
                      commission:
                        description: Money amount
                        type: object
                        required:
                          - amount
                          - amountCents
                          - currency
                        properties:
                          amount:
                            pattern: ^-?\d+\.\d{2}$
                            description: Decimal string, two decimals
                            type: string
                          amountCents:
                            description: 'The same amount in integer cents: amount times 100'
                            type: integer
                          currency:
                            description: ISO 4217 code
                            type: string
                      rebate:
                        description: Money amount
                        type: object
                        required:
                          - amount
                          - amountCents
                          - currency
                        properties:
                          amount:
                            pattern: ^-?\d+\.\d{2}$
                            description: Decimal string, two decimals
                            type: string
                          amountCents:
                            description: 'The same amount in integer cents: amount times 100'
                            type: integer
                          currency:
                            description: ISO 4217 code
                            type: string
                      netPnl:
                        description: betPnl - commission + rebate
                        type: object
                        required:
                          - amount
                          - amountCents
                          - currency
                        properties:
                          amount:
                            pattern: ^-?\d+\.\d{2}$
                            description: Decimal string, two decimals
                            type: string
                          amountCents:
                            description: 'The same amount in integer cents: amount times 100'
                            type: integer
                          currency:
                            description: ISO 4217 code
                            type: string
        '400':
          description: Error. `code` is stable; `message` is for humans and may change.
          content:
            application/json:
              schema:
                description: >-
                  Error. `code` is stable; `message` is for humans and may
                  change.
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - VALIDATION_FAILED
                      - MODE_REQUIRED
                      - INVALID_STAKE
                      - INVALID_PRICE
                      - INVALID_EXPIRY
                      - CURRENCY_NOT_SUPPORTED
                      - BOOKMAKER_NOT_AVAILABLE_VIA_API
                      - BOOKMAKER_NOT_AVAILABLE
                      - INVALID_API_KEY
                      - API_ACCESS_DENIED
                      - ACCOUNT_NOT_ACTIVE
                      - BETTING_NOT_ALLOWED
                      - BALANCE_UNAVAILABLE
                      - INSUFFICIENT_FUNDS
                      - MAX_STAKE_PER_FIXTURE_EXCEEDED
                      - PRICE_NOT_AVAILABLE
                      - PRICE_CHANGED
                      - NO_LIQUIDITY
                      - INSUFFICIENT_LIQUIDITY
                      - CLIENT_ORDER_ID_REUSED
                      - PREVIOUS_ATTEMPT_UNRESOLVED
                      - NOT_FOUND
                      - INVALID_CURSOR
                      - INVALID_WINDOW
                      - ORDER_BUSY
                      - CONFLICT
                      - FORBIDDEN
                      - RATE_LIMITED
                      - BETTING_SUSPENDED
                      - EXPIRY_NOT_AVAILABLE
                      - PUBLIC_API_DISABLED
                      - SERVICE_UNAVAILABLE
                      - UPSTREAM_UNAVAILABLE
                      - FEED_UNAVAILABLE
                      - FEED_TIMEOUT
                      - INTERNAL_ERROR
                  message:
                    type: string
                  details: {}
        '401':
          description: Error. `code` is stable; `message` is for humans and may change.
          content:
            application/json:
              schema:
                description: >-
                  Error. `code` is stable; `message` is for humans and may
                  change.
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - VALIDATION_FAILED
                      - MODE_REQUIRED
                      - INVALID_STAKE
                      - INVALID_PRICE
                      - INVALID_EXPIRY
                      - CURRENCY_NOT_SUPPORTED
                      - BOOKMAKER_NOT_AVAILABLE_VIA_API
                      - BOOKMAKER_NOT_AVAILABLE
                      - INVALID_API_KEY
                      - API_ACCESS_DENIED
                      - ACCOUNT_NOT_ACTIVE
                      - BETTING_NOT_ALLOWED
                      - BALANCE_UNAVAILABLE
                      - INSUFFICIENT_FUNDS
                      - MAX_STAKE_PER_FIXTURE_EXCEEDED
                      - PRICE_NOT_AVAILABLE
                      - PRICE_CHANGED
                      - NO_LIQUIDITY
                      - INSUFFICIENT_LIQUIDITY
                      - CLIENT_ORDER_ID_REUSED
                      - PREVIOUS_ATTEMPT_UNRESOLVED
                      - NOT_FOUND
                      - INVALID_CURSOR
                      - INVALID_WINDOW
                      - ORDER_BUSY
                      - CONFLICT
                      - FORBIDDEN
                      - RATE_LIMITED
                      - BETTING_SUSPENDED
                      - EXPIRY_NOT_AVAILABLE
                      - PUBLIC_API_DISABLED
                      - SERVICE_UNAVAILABLE
                      - UPSTREAM_UNAVAILABLE
                      - FEED_UNAVAILABLE
                      - FEED_TIMEOUT
                      - INTERNAL_ERROR
                  message:
                    type: string
                  details: {}
        '403':
          description: Error. `code` is stable; `message` is for humans and may change.
          content:
            application/json:
              schema:
                description: >-
                  Error. `code` is stable; `message` is for humans and may
                  change.
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - VALIDATION_FAILED
                      - MODE_REQUIRED
                      - INVALID_STAKE
                      - INVALID_PRICE
                      - INVALID_EXPIRY
                      - CURRENCY_NOT_SUPPORTED
                      - BOOKMAKER_NOT_AVAILABLE_VIA_API
                      - BOOKMAKER_NOT_AVAILABLE
                      - INVALID_API_KEY
                      - API_ACCESS_DENIED
                      - ACCOUNT_NOT_ACTIVE
                      - BETTING_NOT_ALLOWED
                      - BALANCE_UNAVAILABLE
                      - INSUFFICIENT_FUNDS
                      - MAX_STAKE_PER_FIXTURE_EXCEEDED
                      - PRICE_NOT_AVAILABLE
                      - PRICE_CHANGED
                      - NO_LIQUIDITY
                      - INSUFFICIENT_LIQUIDITY
                      - CLIENT_ORDER_ID_REUSED
                      - PREVIOUS_ATTEMPT_UNRESOLVED
                      - NOT_FOUND
                      - INVALID_CURSOR
                      - INVALID_WINDOW
                      - ORDER_BUSY
                      - CONFLICT
                      - FORBIDDEN
                      - RATE_LIMITED
                      - BETTING_SUSPENDED
                      - EXPIRY_NOT_AVAILABLE
                      - PUBLIC_API_DISABLED
                      - SERVICE_UNAVAILABLE
                      - UPSTREAM_UNAVAILABLE
                      - FEED_UNAVAILABLE
                      - FEED_TIMEOUT
                      - INTERNAL_ERROR
                  message:
                    type: string
                  details: {}
        '429':
          description: Error. `code` is stable; `message` is for humans and may change.
          content:
            application/json:
              schema:
                description: >-
                  Error. `code` is stable; `message` is for humans and may
                  change.
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - VALIDATION_FAILED
                      - MODE_REQUIRED
                      - INVALID_STAKE
                      - INVALID_PRICE
                      - INVALID_EXPIRY
                      - CURRENCY_NOT_SUPPORTED
                      - BOOKMAKER_NOT_AVAILABLE_VIA_API
                      - BOOKMAKER_NOT_AVAILABLE
                      - INVALID_API_KEY
                      - API_ACCESS_DENIED
                      - ACCOUNT_NOT_ACTIVE
                      - BETTING_NOT_ALLOWED
                      - BALANCE_UNAVAILABLE
                      - INSUFFICIENT_FUNDS
                      - MAX_STAKE_PER_FIXTURE_EXCEEDED
                      - PRICE_NOT_AVAILABLE
                      - PRICE_CHANGED
                      - NO_LIQUIDITY
                      - INSUFFICIENT_LIQUIDITY
                      - CLIENT_ORDER_ID_REUSED
                      - PREVIOUS_ATTEMPT_UNRESOLVED
                      - NOT_FOUND
                      - INVALID_CURSOR
                      - INVALID_WINDOW
                      - ORDER_BUSY
                      - CONFLICT
                      - FORBIDDEN
                      - RATE_LIMITED
                      - BETTING_SUSPENDED
                      - EXPIRY_NOT_AVAILABLE
                      - PUBLIC_API_DISABLED
                      - SERVICE_UNAVAILABLE
                      - UPSTREAM_UNAVAILABLE
                      - FEED_UNAVAILABLE
                      - FEED_TIMEOUT
                      - INTERNAL_ERROR
                  message:
                    type: string
                  details: {}
        '503':
          description: Error. `code` is stable; `message` is for humans and may change.
          content:
            application/json:
              schema:
                description: >-
                  Error. `code` is stable; `message` is for humans and may
                  change.
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                    enum:
                      - VALIDATION_FAILED
                      - MODE_REQUIRED
                      - INVALID_STAKE
                      - INVALID_PRICE
                      - INVALID_EXPIRY
                      - CURRENCY_NOT_SUPPORTED
                      - BOOKMAKER_NOT_AVAILABLE_VIA_API
                      - BOOKMAKER_NOT_AVAILABLE
                      - INVALID_API_KEY
                      - API_ACCESS_DENIED
                      - ACCOUNT_NOT_ACTIVE
                      - BETTING_NOT_ALLOWED
                      - BALANCE_UNAVAILABLE
                      - INSUFFICIENT_FUNDS
                      - MAX_STAKE_PER_FIXTURE_EXCEEDED
                      - PRICE_NOT_AVAILABLE
                      - PRICE_CHANGED
                      - NO_LIQUIDITY
                      - INSUFFICIENT_LIQUIDITY
                      - CLIENT_ORDER_ID_REUSED
                      - PREVIOUS_ATTEMPT_UNRESOLVED
                      - NOT_FOUND
                      - INVALID_CURSOR
                      - INVALID_WINDOW
                      - ORDER_BUSY
                      - CONFLICT
                      - FORBIDDEN
                      - RATE_LIMITED
                      - BETTING_SUSPENDED
                      - EXPIRY_NOT_AVAILABLE
                      - PUBLIC_API_DISABLED
                      - SERVICE_UNAVAILABLE
                      - UPSTREAM_UNAVAILABLE
                      - FEED_UNAVAILABLE
                      - FEED_TIMEOUT
                      - INTERNAL_ERROR
                  message:
                    type: string
                  details: {}
      security:
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key

````

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