API Overview
The Crowd.Credit API provides programmatic access to all platform features including deposits, credit management, yield tracking, and account administration.
Base URL
https://api.crowd.credit/api/v1
Key Concepts
RESTful Design
All endpoints follow REST conventions:
GET-- Retrieve resourcesPOST-- Create resourcesPUT-- Update resources (full replacement)PATCH-- Partial updatesDELETE-- Remove resources
Response Format
All responses return JSON with a consistent envelope:
{
"success": true,
"data": { ... },
"message": null
}
Error responses include error details:
{
"success": false,
"data": null,
"message": "Validation failed",
"errors": [
{ "field": "amount", "message": "Amount must be greater than 0" }
]
}
Pagination
List endpoints support cursor-based pagination:
GET /api/v1/transactions?cursor=abc123&limit=50
| Parameter | Type | Default | Max |
|---|---|---|---|
cursor | string | null | -- |
limit | integer | 25 | 100 |
Available Endpoints
| Category | Base Path | Description |
|---|---|---|
| Accounts | /accounts | Account management and KYC |
| Deposits | /deposits | Deposit and withdrawal operations |
| Credit | /credit | Credit line management |
| Payments | /payments | Payment processing |
| Yield | /yield | Yield tracking and configuration |
| Scores | /scores | CrowdProof reputation scores |
| Webhooks | /webhooks | Webhook subscription management |
Rate Limits
API requests are rate-limited per API key using a sliding window algorithm:
| Tier | Requests/Minute | Requests/Day |
|---|---|---|
| Free | 30 | 1,000 |
| Standard | 120 | 10,000 |
| Premium | 600 | 100,000 |
Rate limit headers are included in every response:
X-RateLimit-Limit: 120
X-RateLimit-Remaining: 119
X-RateLimit-Reset: 1709856000