API reference
Get Started

Getting Started / Try the API

Try the API

Call the hosted Corpact API from this page and see real responses, with no setup.

Live requests

Every request below runs against the hosted API on mainnet data, from your browser, using a read-only demo key. Pick one and press Run.

The corporate-action taxonomy: every type Corpact recognises, and how each one reaches the ledger.

GET/v2/taxonomy

From your terminal

The same call with curl:

curl -s "https://corpactapi-production.up.railway.app/v2/actions?owner=6kn8Vj9YkvNLo8peW2fzebQdSLtX33A3TkRJwXqMCy1U&limit=5" \
  -H "authorization: Bearer cpk_6mTym0MCpOrAqdAyKiW4Flrm0V8JGDuXIjcLCgy0Wzg"

In TypeScript

import { createCorpactClient } from '@corpact/client';

const corpact = createCorpactClient({
  baseUrl: 'https://corpactapi-production.up.railway.app',
  apiKey: 'cpk_6mTym0MCpOrAqdAyKiW4Flrm0V8JGDuXIjcLCgy0Wzg', // read-only demo key
});

const { actions } = await corpact.v2.actions('6kn8Vj9YkvNLo8peW2fzebQdSLtX33A3TkRJwXqMCy1U');

for (const a of actions) {
  console.log(a.type, a.treatment, a.quantityDisplay, a.usd ?? 'USD unknown');
}

See the TypeScript client for every method, and the API reference for every field.

About this demo

  • Read-only. The key holds assets:read and ledger:read only. It cannot sync wallets or change anything.
  • One wallet. It belongs to a demo tenant with a single registered wallet, 6kn8Vj9YkvNLo8peW2fzebQdSLtX33A3TkRJwXqMCy1U. Any other wallet answers 404 wallet_not_registered, which is how tenant isolation works for every customer.
  • Real mainnet data. Chain history comes from Solana; corporate actions come from recorded issuer data.
  • Shared limits. The key is rate-limited and shared by everyone reading these docs. For your own key and your own wallets, follow the Quickstart.