API Documentation
Integrate with Colloseum using our RESTful API
RESTful API
Simple HTTP endpoints with JSON responses
Rate Limited
100 requests per minute per IP address
Secure
JWT authentication for protected endpoints
Code Examples
See how to make API requests in different languages
// Using Fetch API
const response = await fetch('https://yourapp.com/api/auth/login', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
email: 'user@example.com',
password: 'password123'
})
});
const data = await response.json();API Endpoints
Available endpoints and their parameters
POST
/api/auth/signupCreate a new user account
Request Body:
{
"name": "John Doe",
"email": "john@example.com",
"password": "securePassword123"
}Response:
{
"message": "User created successfully"
}POST
/api/auth/loginAuthenticate user and receive auth token
Request Body:
{
"email": "john@example.com",
"password": "securePassword123"
}Response:
{
"user": {
"id": "uuid",
"email": "john@example.com",
"name": "John Doe"
}
}GET
/api/user/exchanges🔒 Auth Required
Get all connected exchanges for authenticated user
Response:
{
"exchanges": [
{
"id": "uuid",
"exchange_id": "binance",
"created_at": "2024-01-01"
}
]
}POST
/api/exchanges🔒 Auth Required
Connect a new exchange
Request Body:
{
"exchangeId": "binance",
"apiKey": "your-api-key",
"apiSecret": "your-api-secret"
}Response:
{
"message": "Exchange connected successfully"
}GET
/api/user/transactions🔒 Auth Required
Get transaction history with pagination
Query Parameters:
{
"exchangeId": "binance",
"limit": "100",
"offset": "0"
}Response:
{
"transactions": [],
"total": 0
}GET
/api/user/holdings🔒 Auth Required
Get current portfolio holdings
Response:
{
"holdings": [
{
"symbol": "BTC",
"balance": 1.5,
"value": 50000
}
]
}POST
/api/reconciliation🔒 Auth Required
Run reconciliation for date range
Request Body:
{
"startDate": "2024-01-01",
"endDate": "2024-12-31"
}Response:
{
"totalTransactions": 100,
"matched": 95,
"unmatched": 5
}GET
/api/pricesGet current cryptocurrency prices
Query Parameters:
{
"symbols": "BTC,ETH,SOL"
}Response:
{
"prices": {
"BTC": {
"usd": 87935,
"usd_24h_change": -0.25
}
}
}