Introduction
The Crane Ledger API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Base URL
https://api.craneledger.ai
All API requests must be made over HTTPS. Calls made over plain HTTP will fail.
Just getting started?
Check out our Quick Start Guide to create your first transaction in under 5 minutes.
API Protocols
Crane Ledger supports three API protocols to fit your integration needs:
Credit-Based Billing
Crane Ledger uses a credit-based billing system. Each API operation consumes a specific number of credits:
| Operation | Credits |
|---|---|
| Read operations (GET) | 0 (free) |
| Create operations (POST) | 1-5 |
| Update operations (PUT/PATCH) | 1-2 |
| Delete operations (DELETE) | 1 |
| Report generation | 5 |
Authentication
All API requests require authentication using an API key. You can create and manage API keys from your dashboard.
curl https://api.craneledger.ai/v1/accounts \
-H "Authorization: Bearer cl_live_xxxxxxxxxxxxxxxxxxxxxxxx"
Keep your API keys secure
Your API keys carry many privileges. Do not share them in publicly accessible areas such as GitHub, client-side code, etc.
Next Steps
- Authentication - Learn about API keys and security
- Quick Start - Create your first transaction
- API Reference - Explore all endpoints
Need help?
Create a free account to access our support portal. Once signed in, use the Support tab in your dashboard to submit a support ticket — our team typically responds within 24 hours.
- ✨ For LLMs/AI assistants: Read our structured API reference