Skip to content

Endpoints

Current MVP

Financial data and company endpoints are available from Phase 3. Search and AI endpoints are Phase 3–5.

Companies

GET /v1/companies

List all tracked companies.

Query Parameters

Parameter Type Description
sector string Filter by sector
limit int Max results (default: 20)
offset int Pagination offset

Response

{
  "success": true,
  "data": [
    { "id": 1, "name": "Maybank", "ticker": "1155", "sector": "Banking" }
  ]
}

GET /v1/companies/{id}

Get a single company profile.

Financial Statements

GET /v1/companies/{id}/income-statement

Parameter Type Description
period string e.g. Q3-2025, FY2024

GET /v1/companies/{id}/balance-sheet

GET /v1/companies/{id}/cash-flow

GET /v1/companies/{id}/ratios

Planned Architecture (Future Phases)

Hybrid semantic search is implemented in Phase 3.

POST /v1/search

{
  "query": "Maybank net interest margin 2024",
  "company_ids": [1, 2],
  "top_k": 5
}

AI Analysis

Planned Architecture (Future Phases)

AI analysis endpoints are implemented in Phase 3 and extended in Phase 5.

POST /v1/ai/summarize

POST /v1/ai/compare

POST /v1/ai/chat