Menu

Navigation

Early Access

API Reference

Complete OpenAPI documentation for the ApiCharge protocol and integration endpoints

Built-in OpenAPI Documentation

ApiCharge includes comprehensive OpenAPI documentation as part of the ApiCharge service itself. When you deploy ApiCharge, the complete API specification is automatically available at your service endpoint, providing:

📋 Complete Specification

Full OpenAPI 3.0 spec with all endpoints, request/response schemas, and authentication details

🎯 Interactive Documentation

Built-in Scalar API documentation with full testing capabilities directly from your browser

🔧 Code Generation

Generate client libraries in multiple programming languages from the OpenAPI spec

📱 Always Up-to-Date

Documentation automatically reflects your current ApiCharge configuration and available routes

Accessing Your API Documentation

Once you have ApiCharge deployed, you can access the documentation at:

  1. OpenAPI Specification: https://your-apicharge-instance/openapi.json
  2. Scalar Documentation: https://your-apicharge-instance/scalar
  3. Interactive API Testing: Full API test pages available through the Scalar interface

Core API Capabilities

The ApiCharge protocol provides endpoints for:

  1. Account Balance Monitoring: Check your account balance and transaction history
  2. ApiCharge Purchase: Purchase time-bound access to protected API routes
  3. Proxied Route Discovery: Discover available protected routes and their configurations
  4. Pricing Quotes: Get real-time pricing information for API access

Ready to Explore the API?

Get early access to ApiCharge and start exploring the complete API documentation with your own deployment.

Request Early Access