API Playground

Interactive API documentation - Try out API requests directly

List Companies

get

Get list of companies with optional filtering

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key obtained from Alpha Lenz dashboard

Query parameters

searchstringOptional

Search by name or symbol

sectorstringOptional

Filter by sector

countrystringOptional

Filter by country

limitinteger · min: 1 · max: 100OptionalDefault: 50

offsetintegerOptionalDefault: 0

Responses

200

Successful response

application/json

401

Unauthorized

application/json

get

/api/public/v1/financial/companies

HTTPcURLJavaScriptPython

GET /api/public/v1/financial/companies HTTP/1.1
Host: api.alpha-lenz.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "companies": [
    {
      "company_id": 1,
      "symbol": "005930",
      "name": "Samsung Electronics",
      "alias_name": "삼성전자",
      "exchange": "KRX",
      "sector": "Technology",
      "country": "KR"
    }
  ],
  "total": 1
}

Quick Start

1. Get your API key from Settings > API Keys

2. Click "Try it out" on any endpoint above

3. Enter your API key in the X-API-Key header

4. Modify parameters and click "Execute"

Available Endpoints

All Public API endpoints are available for interactive testing in this playground.