API 플레이그라운드

대화형 API 문서 - API 요청을 직접 테스트해보세요

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

totalintegerOptional

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
}

빠른 시작

1. 설정 > API 키에서 API 키 발급

2. 위 엔드포인트에서 "Try it out" 클릭

3. X-API-Key 헤더에 API 키 입력

4. 파라미터 수정 후 "Execute" 클릭

사용 가능한 엔드포인트

모든 Public API 엔드포인트를 이 플레이그라운드에서 대화형으로 테스트할 수 있습니다.