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

# Get payout wallet stats

> Read-only summary of your company's payout wallet balances and lifetime activity.

Returns the same metrics shown on the payouts dashboard:
- **Available balance** — funds ready to pay creators
- **Pending balance** — incoming top-ups still processing
- **Total owed** — calculated amount owed across active contracts
- **Lifetime deposits** — total confirmed wallet top-ups
- **Lifetime paid out** — total confirmed payouts to creators

All amounts are in USD dollars.




## OpenAPI

````yaml /openapi/platform-apikey.yaml get /payouts/stats
openapi: 3.0.4
info:
  title: Sideshift Public API
  version: 1.0.0
  description: >
    REST API for Sideshift platform. Authenticate using your API key in the
    `x-api-key` header.


    This document covers the **public, API-key-authenticated** surface. The

    restricted endpoints (Jobs, Applicants, payout execution/Quick Pay) are
    gated

    to an explicit partner allowlist and are documented in the **Full Access**

    spec (`sideshift-api-private.yaml`); a non-allowlisted key calling them

    receives `403`. API-key *management* (creating/rotating keys, digest

    automations) is performed in the dashboard with a Firebase session and is
    not

    part of this API-key contract.


    ## Requirements

    - **Active Subscription Required**: API access requires an active Sideshift
      subscription. Requests from a company without one return
      `402 { "error": "Active subscription required" }`.
    - API key from Settings → Integrations


    ## Rate Limits

    - Default: **100 requests per minute** per API key.

    - Allowlisted partner accounts: **400 requests per minute**.

    - Every response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and
      `X-RateLimit-Reset` headers; exceeding the limit returns `429`.

    ## Errors

    - Errors are returned as `{ "error": "<message>" }` with the appropriate
    HTTP
      status (`400` invalid request, `401` invalid/missing key, `402` no active
      subscription, `403` restricted endpoint / cross-company, `404` not found,
      `429` rate limited). Some endpoints add a `code` (e.g. `LEAD_NOT_FOUND`).

    ## Timestamps

    - All timestamps are Unix timestamps in milliseconds

    - Example: `1634567890000`


    ## Pagination

    - Most list endpoints support `page` (default: 1) and `limit` (default: 25,
      max: 100) parameters and return `{ data, page, total }`. Some additionally
      return `limit` and/or `totalPages`.
    - Agency (parent) accounts can pass `scope=agency` on analytics/posts
      endpoints to aggregate across the parent agency and every subaccount.

    ## Base URL

    - Production: `https://app.sideshift.app/api/v1`
servers:
  - url: https://app.sideshift.app/api/v1
    description: Production server
security:
  - apiKeyAuth: []
tags:
  - name: Programs
    description: Campaign and program management
  - name: Posts
    description: Social media posts and content
  - name: Analytics
    description: Performance metrics and KPIs
  - name: Payouts
    description: Payout management including pending payouts and execution
  - name: Contracts
    description: Creator contracts and agreements
  - name: Creators
    description: Creator profiles and statistics
  - name: Invoices
    description: Create, list, and send invoices to customers
  - name: Discover
    description: Read Discover leads (brand inquiries) submitted to your agency
paths:
  /payouts/stats:
    get:
      tags:
        - Payouts
      summary: Get payout wallet stats
      description: >
        Read-only summary of your company's payout wallet balances and lifetime
        activity.


        Returns the same metrics shown on the payouts dashboard:

        - **Available balance** — funds ready to pay creators

        - **Pending balance** — incoming top-ups still processing

        - **Total owed** — calculated amount owed across active contracts

        - **Lifetime deposits** — total confirmed wallet top-ups

        - **Lifetime paid out** — total confirmed payouts to creators


        All amounts are in USD dollars.
      responses:
        '200':
          description: Successfully retrieved payout stats
          content:
            application/json:
              schema:
                type: object
                properties:
                  availableBalance:
                    type: number
                    description: Available wallet balance in dollars
                  pendingBalance:
                    type: number
                    description: Pending top-up balance in dollars
                  totalOwed:
                    type: number
                    description: >-
                      Total amount owed to creators across active contracts in
                      dollars
                  lifetimeDeposits:
                    type: number
                    description: Lifetime confirmed wallet deposits in dollars
                  lifetimePaidOut:
                    type: number
                    description: Lifetime confirmed payouts to creators in dollars
                  currency:
                    type: string
                    enum:
                      - usd
        '401':
          description: Invalid or missing API key
        '402':
          description: Active subscription required
        '429':
          description: Rate limit exceeded
        '500':
          description: Internal server error
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Get yours from Settings → Integrations

````