Documentation
Documentation

Overview

Spore docs

Start here

Getting startedInstall the CLIAuthentication and keys

Build

Search and filtersSegments and the loopEnrichment lifecycle

Recipes

Recipe: search to a live SegmentRecipe: enrich without a segmentRecipe: land your own research

Connect

Events

Account

Credits and billing

Reference

Conventions
API reference
Export the organization's Operation calls POSTPage the organization's Operation calls GETExport the organization's recorded acts POSTPage the organization's recorded acts GETCancel an enrichment launch POSTRead a vocabulary: tools, filters, knowledge, or NACE GETPublish a staged Commons Generation POSTRestore the retained previous Commons Generation POSTPage the organization's Companies GETCorrect a Company's Core under Spore-If-Match PATCHDelete a Company DELETERead everything you know about one Company GETRead Legal entity data for Companies you hold POSTFind Legal entities in the Commons POSTFold one Company into another POSTMint Companies from your own data, or attach rows to Companies you hold POSTPromote a declared current Fact into Company Core POSTRead one Company GETMeasure requested fields over a set of Companies POSTRun a native enrichment POSTPoll an enrichment GETFollow the organization's durable events stream GETPage a Job's frozen target list GETCreate an API key and reveal its secret once POSTRevoke an organization API key POSTList per-item enrichment outcomes GETDeclare a namespace and its fields before recording into them POSTDelete a declaration while nothing stands on it DELETERead your Catalog GETRecord what you observed about a Company or concluded about a Segment POSTUnlock every Legal entity a search matched POSTSearch the Commons: count, analytics, and a minted sample POSTPage a Segment's members, with the exact count GETName a live filter over your Companies POSTDelete a Segment DELETERead what you have concluded about one Segment GETRename a Segment, or change what it means, under Spore-If-Match PATCHRead a Segment's name and filter GETPage the organization's Segments GETPage the organization's credit ledger GETRead the balance and this key's spend bounds GET
API reference

Read the balance and this key's spend bounds

Current Balance plus optional Committed, Spendable, and period Spent totals. `keyBounds` carries this key's scopes, per-request ceiling, rolling budget, budget window, and remaining headroom; `budgetPeriodDays` and `budgetRemaining` are null when the key has no budget. The read is organization-wide. Free.

GET
/api/v1/wallet

Current Balance plus optional Committed, Spendable, and period Spent totals. keyBounds carries this key's scopes, per-request ceiling, rolling budget, budget window, and remaining headroom; budgetPeriodDays and budgetRemaining are null when the key has no budget. The read is organization-wide.

Free.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/wallet"
{  "balance": 500,  "committed": 120,  "spendable": 380,  "spentThisPeriod": 42,  "lifetimePurchased": 0,  "lifetimeGranted": 500,  "lifetimeUsed": 42,  "keyBounds": {    "scopes": [      "company:read",      "search:run"    ],    "maxRequestCredits": 200,    "budgetCredits": 2000,    "budgetPeriodDays": 30,    "budgetRemaining": 2000  }}

Page the organization's credit ledger GET

Every credit change, newest first, paged by opaque cursor. Pass `apiKeyId` to narrow the ledger to one principal's spend. Reads are organization-scoped. Free.