Get started with Calypso API

Overview

Use this section to prepare a Calypso Public API integration for crypto payments, payouts, invoices, exchange, reports, and webhooks.

Before implementing product-specific API flows, make sure your integration supports API authentication, request signing, timestamp validation, webhook signature verification, idempotent webhook processing, error handling, and tolerant response parsing.

Recommended setup flow

1. Create API keys in the Calypso UI and store the public key and secret key securely.
2. Implement request signing by using HMAC-SHA512 over the exact JSON request body.
3. Send the required Key, Sign, and Content-Type headers with every API request.
4. Implement error handling for standard Calypso API error codes.
5. Create webhook subscriptions for the events required by your integration.
6. Verify webhook signatures, process webhook payloads idempotently, and request the current object state from the API when webhook order is uncertain.

Guides

Guide	Description
API Authentication	Learn how to sign Calypso API requests.
Webhook subscriptions	Learn how webhook subscriptions, delivery, signatures, and payloads work.
ENUM descriptions	Check common enum values used in API requests and responses.
Errors	Check standard Calypso API error response format and error codes.

Related docs

Document	Link
Create API keys in UI	How to create API keys
Public API reference	API reference