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

# Get account summary

> Returns a best-effort snapshot of your Circle Match USDC balance, open-order exposure, and windowed activity totals. Use this for pre-order balance checks and dashboard display. For exact reconciliation, use your order and settlement records instead.



## OpenAPI

````yaml openapi/match.yaml get /v1/match/account
openapi: 3.1.0
info:
  title: Circle Match API
  description: >
    The Circle Match API provides endpoints for Circle Match, a periodic

    batch-auction venue that coordinates USDC burn demand with USDC mint demand

    for eligible Circle Mint customers.


    ## Authentication


    All REST endpoints require a Bearer token:


    ```

    Authorization: Bearer <API_KEY>

    ```


    ## WebSocket


    Real-time auction state and account events are delivered over a persistent

    WebSocket connection at `wss://api.circle.com/v1/match/ws` (production) or

    `wss://api-sandbox.circle.com/v1/match/ws` (sandbox).


    Obtain a short-lived ticket with `POST /v1/match/ws/ticket`, then pass two

    `Sec-WebSocket-Protocol` values in the upgrade request:


    - `circle-match.v1`

    - `ticket.<jwt>` — the ticket value, prefixed with `ticket.`


    After connection, subscribe to the `market` channel for public auction state

    or the `account` channel for private order and fill events. See the Circle

    Match WebSocket reference for the full protocol specification.


    ## Error codes


    | Code   | HTTP | Description |

    |--------|------|-------------|

    | 136001 | 400  | Auction locked — cancellations and less-competitive fee
    changes not accepted |

    | 136002 | 400  | Auction settling — try again after settlement completes |

    | 137001 | 400  | Insufficient available balance |

    | 137002 | 400  | Invalid wallet |

    | 137003 | 400  | Wallet not found |

    | 137004 | 409  | Idempotency key reused with different parameters |

    | 137005 | 400  | Fee change not more competitive during lock window |

    | 137006 | 409  | Self-match violation — open order on opposite side of same
    auction |

    | 137007 | 400  | Invalid fiat account |

    | 137008 | 400  | Maximum orders per auction reached |

    | 137009 | 400  | Transaction limit exceeded |

    | 137010 | 400  | Entity not eligible for Circle Match |

    | 138001 | 400  | Withdrawal amount exceeds available balance |

    | 138002 | 400  | Withdrawal request invalid |

    | 138003 | 404  | No Circle Match account found for this entity |

    | 138004 | 400  | Invalid withdrawal destination |

    | 139001 | 400  | Circle Match wallet invalid |
  version: 1.0.0
servers:
  - url: https://api.circle.com
    description: Production
  - url: https://api-sandbox.circle.com
    description: Sandbox
security:
  - BearerAuth: []
tags:
  - name: Account
    description: Account balance and activity summary
  - name: Orders
    description: Place, list, retrieve, cancel, and modify orders
  - name: Withdrawals
    description: Withdraw restricted mint-side USDC
  - name: WebSocket
    description: Obtain a WebSocket connection ticket
paths:
  /v1/match/account:
    get:
      tags:
        - Account
      summary: Get account summary
      description: >-
        Returns a best-effort snapshot of your Circle Match USDC balance,
        open-order exposure, and windowed activity totals. Use this for
        pre-order balance checks and dashboard display. For exact
        reconciliation, use your order and settlement records instead.
      operationId: getAccount
      responses:
        '200':
          description: Account summary
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    $ref: '#/components/schemas/AccountSummary'
              example:
                data:
                  accountId: cm_acct_abc123
                  usdc:
                    available:
                      amount: '4000.00'
                      currency: USD
                    reserved:
                      amount: '1000.00'
                      currency: USD
                    total:
                      amount: '5000.00'
                      currency: USD
                  exposure:
                    activeOrderCount: 2
                    mintOrderCount: 0
                    burnOrderCount: 2
                  activity:
                    from: '2026-08-01T00:00:00Z'
                    to: '2026-08-31T23:59:59Z'
                    totalMatched:
                      amount: '18000.00'
                      currency: USD
                    rebatesEarned:
                      amount: '50.00'
                      currency: USD
                    feesPaid:
                      amount: '30.00'
                      currency: USD
        '400':
          description: Circle Match wallet invalid (error 139001)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 139001
                message: Circle Match wallet invalid
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No Circle Match account found for this entity (error 138003)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 138003
                message: No Circle Match wallet found
components:
  schemas:
    AccountSummary:
      type: object
      required:
        - accountId
        - usdc
        - exposure
        - activity
      properties:
        accountId:
          type: string
          description: Unique Circle Match account identifier
          example: cm_acct_abc123
        usdc:
          $ref: '#/components/schemas/AccountUsdcBalance'
        exposure:
          $ref: '#/components/schemas/AccountExposure'
        activity:
          $ref: '#/components/schemas/ActivityTotals'
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: integer
          description: Circle error code
          example: 137001
        message:
          type: string
          description: Human-readable error description
          example: Insufficient available balance
    AccountUsdcBalance:
      type: object
      required:
        - available
        - reserved
        - total
      properties:
        available:
          $ref: '#/components/schemas/Money'
        reserved:
          $ref: '#/components/schemas/Money'
        total:
          $ref: '#/components/schemas/Money'
    AccountExposure:
      type: object
      required:
        - activeOrderCount
        - mintOrderCount
        - burnOrderCount
      properties:
        activeOrderCount:
          type: integer
          description: Total number of currently resting orders across both sides
          example: 3
        mintOrderCount:
          type: integer
          description: Number of currently resting MINT orders
          example: 1
        burnOrderCount:
          type: integer
          description: Number of currently resting BURN orders
          example: 2
    ActivityTotals:
      type: object
      required:
        - from
        - to
        - totalMatched
        - rebatesEarned
        - feesPaid
      properties:
        from:
          type: string
          format: date-time
          description: Start of the activity window (inclusive)
          example: '2026-08-01T00:00:00Z'
        to:
          type: string
          format: date-time
          description: End of the activity window (inclusive)
          example: '2026-08-31T23:59:59Z'
        totalMatched:
          allOf:
            - $ref: '#/components/schemas/Money'
          description: Total USD volume matched during the window
        rebatesEarned:
          allOf:
            - $ref: '#/components/schemas/Money'
          description: Gross rebates received (mint-side; non-negative)
        feesPaid:
          allOf:
            - $ref: '#/components/schemas/Money'
          description: Gross fees paid (burn-side; non-negative)
    Money:
      type: object
      description: A monetary amount with its currency
      required:
        - amount
        - currency
      properties:
        amount:
          type: string
          description: Decimal amount as a string, rounded to 2 decimal places
          example: '500.00'
        currency:
          type: string
          description: ISO 4217 currency code
          example: USD
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````