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

# Read the balance



## OpenAPI

````yaml /openapi.json get /credits/
openapi: 3.1.0
info:
  title: Datacircle API
  version: '1'
servers:
  - url: https://idle.api.datacircle.dev
security:
  - token: []
tags:
  - name: Datacircle
    description: 'Your Datacircle account: credits, checkout, files, invites, API key.'
  - name: iBlinked
    description: >-
      LinkedIn Profile API: iBlinked's own request, sent to api.datacircle.dev
      with your Datacircle key and `X-Data-Provider: iblinked`.
  - name: Up2Data
    description: >-
      LinkedIn Profile API: Up2Data's own request, sent to api.datacircle.dev
      with your Datacircle key and `X-Data-Provider: up2data`.
paths:
  /credits/:
    get:
      tags:
        - Datacircle
      summary: Read the balance
      responses:
        '200':
          description: Balance split by kind
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credits'
components:
  schemas:
    Credits:
      type: object
      properties:
        balance_usd:
          type: number
          description: >-
            Everything you can spend right now, in USD: `signup_usd` +
            `bought_usd` + `manual_usd` (permanent) + every
            `temporary[].remaining_usd` (temporary).
            `datacircle_meta.credits_remaining` on a provider call is this
            number after the call.
        signup_usd:
          type: number
          description: >-
            Permanent: what is left of the 5 USD signup credit every workspace
            gets once. Never expires. Spent after temporary credit, before
            bought and manual credit.
        bought_usd:
          type: number
          description: >-
            Permanent: what is left of the credit you bought through Stripe
            Checkout (`POST /checkout/`). Never expires. Spent after temporary
            and signup credit, together with manual credit, oldest first.
        manual_usd:
          type: number
          description: >-
            Permanent: what is left of credit Datacircle added to your workspace
            by hand (a refund, a gift, a deal). Never expires. Spent after
            temporary and signup credit, together with bought credit, oldest
            first. 0 for most workspaces.
        temporary:
          type: array
          items:
            type: object
            properties:
              campaign:
                type: string
                description: >-
                  The campaign that gave this credit, e.g. `launch_20` (the
                  launch week's 20 USD).
              remaining_usd:
                type: number
                description: >-
                  Temporary: what is left of this grant, in USD, until
                  `expires_at`. Also capped by what is left of the campaign's
                  shared budget, so it can drop to 0 before then.
              expires_at:
                type: string
                format: date-time
                description: >-
                  When this grant expires (ISO 8601): after it, what is left is
                  gone. The launch campaign's 20 USD expires 24 hours after it
                  was granted, on your workspace's first authenticated call in
                  launch week.
          description: >-
            Temporary credit: one entry per campaign grant that has not expired
            yet, soonest to expire first; empty when you have none. Spent before
            any permanent credit. At `expires_at` the entry leaves this list and
            whatever is left of it is gone.
        coop_file_unlocked:
          type: boolean
          description: >-
            `true` once this workspace may download the co-op file (`coop`): it
            spent 50 USD on credit in total (for the foreseeable future), or 3
            people you invited signed up (`GET /me/invites/`). `GET /files/`
            then shows it `allowed`. It says nothing about the 50M US dataset
            (`us_50m`), which only invites unlock.
  securitySchemes:
    token:
      type: apiKey
      in: header
      name: Authorization
      description: '`Token <your API key>`'

````

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