API Reference

Live

Complete reference for the ABAXUS API. Build powerful usage-based billing systems with our RESTful API endpoints.

Base URL: https://api.abaxus.com/v2

Format: JSON

Authentication

ABAXUS API uses API keys for authentication. Include your API key in the Authorization header using Bearer authentication.

Request Header

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

cURL Example

curl -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  https://api.abaxus.com/v2/events

API Key Security

Keep your API keys secure and never expose them in client-side code. Rotate keys regularly for enhanced security.

Send Usage Events

POST /events

Record usage events for real-time metering and billing calculations.

POST

Request Body

{
  "customer_id": "cust_1234567890",
  "event_type": "api_call",
  "timestamp": "2025-01-15T10:30:00Z",
  "properties": {
    "endpoint": "/v1/data/export",
    "response_size": 1024,
    "region": "us-west-2"
  },
  "value": 1
}

customer_id required

Unique identifier for the customer

event_type required

Type of usage event being recorded

timestamp optional

ISO 8601 timestamp (defaults to current time)

Response

{
  "event_id": "evt_987654321",
  "status": "accepted",
  "processed_at": "2025-01-15T10:30:01Z",
  "customer_id": "cust_1234567890"
}

200 OK

Event successfully recorded and queued for processing

Rate Limits

ABAXUS API implements rate limiting to ensure fair usage and system stability. Rate limits are applied per API key.

10,000

Events per minute

Standard rate limit

1,000

API calls per minute

General endpoints

100

Bulk operations per hour

Data exports and reports

Rate Limit Headers

X-RateLimit-Limit: 10000
X-RateLimit-Remaining: 9847
X-RateLimit-Reset: 1642249200

SDKs & Libraries

Node.js

Official JavaScript SDK

npm install abaxus-node

View Documentation

Python

Official Python SDK

pip install abaxus-python

View Documentation

Go

Official Go SDK

go get github.com/abaxus/go-sdk

View Documentation

Status Codes & Errors

Success Codes

200 OK - Request successful

201 Created - Resource created

204 No Content - Success with no response body

Error Codes

400 Bad Request - Invalid parameters

401 Unauthorized - Invalid API key

429 Too Many Requests - Rate limit exceeded

Need Help?

Our developer support team is here to help you integrate ABAXUS API successfully. Get expert assistance and best practices guidance.

Contact Support Join Discord