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

# Read the balance

> Your balance, in dollars: `balance_usd` is everything your calls can spend right now, then what it is made of: what is left of the signup credit, of the funds you added, of manual credits, and every temporary credit with its expiry. Read it to know whether it covers the calls you are about to make. Free.



## OpenAPI

````yaml /openapi.json get /balance/
openapi: 3.1.0
info:
  title: Datacircle API
  version: '1'
  description: >-
    Datacircle is a data co-op.


    Step 1: Query your favorite B2B data APIs through us. Same request, same
    price, no markup.


    Step 2: You're DONE. Every morning, you get the flat file of your data plus
    everyone else's.


    You send the provider's own request to api.datacircle.dev, with your
    Datacircle key. That's the only change.


    Right now we have 3 live LinkedIn profile APIs that we trust: Up2Data,
    HarvestAPI and Fetchin. Each request goes to the provider and gets the
    profile as it is today.


    Add \$50 to your account: you get \$50 of API PLUS the flat file.


    Sign up at datacircle.dev with your work email: a \$5 credit, that's 2,105
    LinkedIn profiles at \$2.375 per 1,000.


    Use it from Claude, ChatGPT or Cursor: add api.datacircle.dev/mcp as an MCP
    server.


    The docs: [docs.datacircle.dev](https://docs.datacircle.dev).
  termsOfService: https://datacircle.dev/terms
  contact:
    name: Datacircle
    url: https://datacircle.dev
    email: wayne@datacircle.dev
  x-logo:
    url: https://datacircle.dev/favicon.png
    altText: Datacircle
servers:
  - url: https://api.datacircle.dev
security:
  - token: []
tags:
  - name: Datacircle
    description: 'Your Datacircle account: balance, adding funds, files, API key.'
  - name: Up2Data
    description: >-
      LinkedIn Profile API: Up2Data's own request, sent to api.datacircle.dev
      with your Datacircle key and `X-Data-Provider: up2data`.
  - name: HarvestAPI
    description: >-
      LinkedIn Profile API: HarvestAPI's own request, sent to api.datacircle.dev
      with your Datacircle key and `X-Data-Provider: harvestapi`.
  - name: Fetchin
    description: >-
      LinkedIn Profile API: Fetchin's own request, sent to api.datacircle.dev
      with your Datacircle key and `X-Data-Provider: fetchin`.
externalDocs:
  description: Datacircle docs
  url: https://docs.datacircle.dev
paths:
  /balance/:
    get:
      tags:
        - Datacircle
      summary: Read the balance
      description: >-
        Your balance, in dollars: `balance_usd` is everything your calls can
        spend right now, then what it is made of: what is left of the signup
        credit, of the funds you added, of manual credits, and every temporary
        credit with its expiry. Read it to know whether it covers the calls you
        are about to make. Free.
      responses:
        '200':
          description: Balance split by kind
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Balance'
              example:
                balance_usd: 4.93591
                signup_credit_usd: 4.93591
                funds_usd: 0
                manual_credit_usd: 0
                temporary_credits: []
components:
  schemas:
    Balance:
      type: object
      properties:
        balance_usd:
          type: number
          description: >-
            Everything you can spend right now, in dollars: `signup_credit_usd`
            + `funds_usd` + `manual_credit_usd` (permanent) + every
            `temporary_credits[].credit_usd` (temporary).
            `datacircle_meta.balance_usd` on a provider call is this number
            after the call.
        signup_credit_usd:
          type: number
          description: >-
            Permanent: what is left of the $5 signup credit every workspace gets
            once. Never expires.
        funds_usd:
          type: number
          description: >-
            Permanent: what is left of the funds you added through Stripe
            Checkout (`POST /checkout/`). Never expires.
        manual_credit_usd:
          type: number
          description: >-
            Permanent: what is left of the credits Datacircle added to your
            workspace by hand (a refund, a gift, a deal). Never expires. 0 for
            most workspaces.
        temporary_credits:
          type: array
          items:
            type: object
            properties:
              campaign:
                type: string
                description: The campaign that gave this credit, by its name.
              credit_usd:
                type: number
                description: >-
                  Temporary: what is left of this credit until `expires_at`, in
                  dollars. 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.
          description: >-
            Temporary credits: one entry per campaign grant that has not expired
            yet, soonest to expire first. Empty when you have none. At
            `expires_at` the entry leaves this list and whatever is left of it
            is gone.
  securitySchemes:
    token:
      type: http
      scheme: bearer
      description: >-
        Your API key: `Authorization: Bearer <your API key>`. `Authorization:
        Token <your API key>` works too.

````

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