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

ParameterTypeRequiredDescription
tickerStringYesStock ticker symbol (e.g., BBCA, TLKM)
fromDateYesStart date in YYYY-MM-DD format
toDateYesEnd date in YYYY-MM-DD format
investorEnumYesType of investor. One of: all, f (foreign), or, d (domestic).

Live API Playground

Example Request

curl -X 'GET' \
  'https://api.indexalpha.id/stocks/broker-summary?ticker=BBCA&from=2026-03-26&to=2026-03-26&investor=all' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <your_api_token>'

Response Format

{
  "success": true,
  "data": [
    {
      "code": "SQ",
      "buy_freq": 4044,
      "buy_volume": 26837300,
      "buy_value": 185357180000,
      "sell_freq": 586,
      "sell_volume": 1499300,
      "sell_value": 10374017500,
      "buy_avg": 6906.70,
      "sell_avg": 6919.24
    },
    {
      "code": "AK",
      "buy_freq": 4355,
      "buy_volume": 16591800,
      "buy_value": 114517012500,
      "sell_freq": 5542,
      "sell_volume": 19340600,
      "sell_value": 133580562500,
      "buy_avg": 6902.02,
      "sell_avg": 6906.74
    }
  ],
  "error": null
}

2. Check Usage & Limits

Monitor your monthly call usage and remaining quota.

Endpoint: GET /usage

Example Request

curl -X 'GET' \
  'https://api.indexalpha.id/usage' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <your_api_token>'

Response Format

{
  "success": true,
  "data": {
    "api_key": "ia_l...H_Qv",
    "monthly_limit": 25000,
    "current_usage": 3,
    "remaining": 24997,
    "reset_date": "2026-04-01T00:00:00"
  },
  "error": null
}

On this page