​
API Reference

Welcome to the LedgerBeam API Reference. Our RESTful API provides programmatic access to transaction enrichment, entity identification, categorization, and recurrence detection capabilities.

​
Base URL

All API requests should be made to: 
https://api.ledgerbeam.com/v1

​
Authentication

All API requests require authentication using your API key. Include it in the API-KEY header: 
API-KEY: YOUR_API_KEY

​
Request Format

All requests should include the following headers:
  • Content-Type: application/json
  • API-KEY: YOUR_API_KEY

​
Response Format

All API responses are returned in JSON format with the following structure:

​
Success Response

{
    // Response data here
}

​
Error Response

{
  "error": {
    "description": [
      "Error message here"
    ]
  }
}

​
Rate Limits

  • Free Plan: 1,000 requests per minute
  • Pro Plan: 10,000 requests per minute
  • Enterprise Plan: Custom limits
Rate limit headers are included in all responses:
  • X-RateLimit-Limit: Maximum requests per window
  • X-RateLimit-Remaining: Remaining requests in current window
  • X-RateLimit-Reset: Time when the rate limit resets

​
Error Handling

The API uses standard HTTP status codes:
  • 200 - Success
  • 400 - Bad Request (invalid parameters)
  • 401 - Unauthorized (invalid API key)
  • 403 - Forbidden (insufficient permissions)
  • 404 - Not Found
  • 429 - Too Many Requests (rate limit exceeded)
  • 500 - Internal Server Error

​
Getting Started

  1. Get your API key from the dashboard
  2. Enrich your first transaction using the Transaction Enrichment endpoint
  3. Explore the endpoints to understand all available features

​
Support

Need help with the API? Check out our: