> ## Documentation Index
> Fetch the complete documentation index at: https://api.tryspecter.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get credit balance
> Returns the calling organization's API credit balance for the current billing window — the provisioned limit, credits used, and credits remaining. This endpoint stays readable when the balance is exhausted, so you can always check where you stand.
This endpoint is free — no credits are charged.
## OpenAPI
````yaml /api-ref/bundle_api.yaml get /organization/credits
openapi: 3.0.0
info:
title: Specter API
termsOfService: https://tryspecter.com/terms/
contact:
name: API support
email: api-support@tryspecter.com
version: 1.0.0
servers:
- description: Production
url: https://app.tryspecter.com/api/v1
security:
- ApiKeyAuth: []
tags:
- name: Enrich
description: >
Look up a company, person, or investor and, if Specter does not already
hold it, fetch it on demand. Includes email-based person enrichment.
- name: Search
description: |
Find records across every product from a single plain-English query.
- name: Companies
description: >
Company profiles, funding, headcount, traction, the per-company signals
and sub-resources attached to a single company, and identifier resolution.
- name: People
description: >
Specter people records: profile data, contact details, and per-person
lookups for a known person ID.
- name: Investors
description: >
Specter investor records: profile, activity, targeting, funds, portfolio
companies, and the funding rounds they have participated in.
- name: Transactions
description: |
Transaction detail by ID: funding rounds, acquisitions, and IPOs.
- name: News Signals
description: |
Company-level news signals: by ID, and for a saved list or company search.
- name: Revenue Signals
description: >
Revenue and profitability signals: by ID, by date, and for a saved list or
company search.
- name: Talent Signals
description: |
Talent signals: by ID and in bulk by ID.
- name: Investor Interest Signals
description: |
Investor interest signals: by ID and in bulk by ID.
- name: Company Lists
description: |
Create, query, and maintain lists of companies, including their results.
- name: Investor Lists
description: |
Create, query, and maintain lists of investors, including their results.
- name: People Lists
description: |
Create, query, and maintain lists of people, including their results.
- name: Saved Searches
description: |
List and delete searches saved via tryspecter.com.
- name: Company Saved Searches
description: |
Details and results for saved company searches.
- name: People Saved Searches
description: |
Details and results for saved people searches.
- name: Investor Saved Searches
description: |
Details and results for saved investor searches.
- name: Talent Signals Saved Searches
description: |
Details and results for saved Talent Signals searches.
- name: Investor Interest Saved Searches
description: |
Details and results for saved Investor Interest Signals searches.
- name: Network
description: >
Your team's LinkedIn network: the people and companies your teammates are
connected to, and your reach into a given company.
- name: Account
description: >
Organisation-level resources: your team's members, API call logs, and
credit balance.
paths:
/organization/credits:
get:
tags:
- Account
summary: Get credit balance
description: >
Returns the calling organization's API credit balance for the current
billing window — the provisioned limit, credits used, and credits
remaining. This endpoint stays readable when the balance is exhausted,
so you can always check where you stand.
This endpoint is free — no credits are charged.
operationId: getCreditBalance
responses:
'200':
$ref: '#/components/responses/CreditBalanceResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimits'
components:
responses:
CreditBalanceResponse:
description: The organization's API credit balance for the current billing window.
content:
application/json:
schema:
type: object
properties:
credit_limit:
description: >
The provisioned monthly credit budget for the organization. A
value of `-1` means unlimited.
type: integer
example: 100000
used:
description: Credits consumed so far in the current billing window.
type: integer
example: 42000
remaining:
description: Credits left in the current billing window.
type: integer
example: 58000
unlimited:
description: Whether the organization has an unlimited credit budget.
type: boolean
example: false
required:
- credit_limit
- used
- remaining
- unlimited
additionalProperties: false
Unauthorized:
description: Unauthorized
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ApiKeyMissing'
- $ref: '#/components/schemas/ApiKeyNotValid'
RateLimits:
description: Too Many Requests - API Rate limit exceeded
content:
application/json:
schema:
type: object
required:
- errorCode
- message
properties:
errorCode:
type: string
description: RATE_LIMITED
message:
type: string
description: You have been rate-limited
headers:
X-RateLimit-Limit:
schema:
type: integer
description: The total rate limit allowed for this endpoint
X-RateLimit-Remaining:
schema:
type: integer
description: The number of requests remaining
X-RateLimit-Reset:
schema:
type: number
format: float
description: The number of seconds until the rate limit resets
schemas:
ApiKeyMissing:
properties:
errorCode:
description: API_KEY_MISSING
example: API_KEY_MISSING
type: string
message:
description: No API Key was presented on the header X-API-KEY
example: No API Key was presented on the header X-API-KEY
type: string
ApiKeyNotValid:
properties:
errorCode:
description: API_KEY_NOT_VALID
example: API_KEY_NOT_VALID
type: string
message:
description: API key present, but not valid
example: API key present, but not valid
type: string
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-Key
````