API Endpoints
Detailed reference for the Index Alpha API endpoints.
1. Broker Summary
Retrieve aggregated daily activity for brokers on a specific stock ticker.
Endpoint: GET /stocks/broker-summary
Data Scope & Schedule: This endpoint only provides data for the Regular Market. Records are updated every trading day at 12:00 GMT (19:00 Asia/Jakarta). Historical data is currently available starting from June 2025.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ticker | String | Yes | Stock ticker symbol (e.g., BBCA, TLKM) |
from | Date | Yes | Start date in YYYY-MM-DD format |
to | Date | Yes | End date in YYYY-MM-DD format |
investor | Enum | Yes | Type of investor. One of: all, f (foreign), or, d (domestic). |
Live API Playground
Example Request
curl -X GET "https://api.indexalpha.com/stocks/broker-summary?ticker=BBCA&from=2026-01-01&to=2026-01-14&investor=all" \
-H "Authorization: Bearer <your_api_token>"Response Format
{
"success": true,
"data": [
{
"date": "2026-01-14",
"code": "BBCA",
"broker": "CC",
"net_val": 15000000.0,
"total_val": 50000000.0,
"avg_price": 9550.25
}
]
}2. Check Usage & Limits
Monitor your monthly call usage and remaining quota.
Endpoint: GET /usage
Example Request
curl -X GET "https://api.indexalpha.com/usage" \
-H "Authorization: Bearer <your_api_token>"Response Format
{
"success": true,
"data": {
"api_key": "abcd...wxyz",
"monthly_limit": 1000,
"current_usage": 150,
"remaining": 850,
"reset_date": "2026-02-01T00:00:00"
}
}