REST API
Byul REST API v2 provides access to financial news data through RESTful JSON endpoints. Base URL:https://api.byul.ai/api/v2
Features
- Financial news data access
- Importance scoring (1-10)
- Symbol-based filtering
- Cursor-based pagination
- Real-time updates
- Date range filtering (startDate/endDate)
Authentication
Include your API key in the request header:Quick Example
Endpoints
GET /news
Retrieve financial news articles. Parameters:limit
(integer): Articles to return (1-100, default: 20)minImportance
(integer): Minimum importance score (1-10, default: 1)symbol
(string): Filter by stock symbolq
(string): Search querycursor
(string): Pagination cursorcategory
(string): News category filterstartDate
(string): Start of date range (ISO 8601)endDate
(string): End of date range (ISO 8601)
Rate Limits
Plan | Rate Limit |
---|---|
Test (Free) | 30 requests/minute |
Starter | 60 requests/minute |
Pro | 120 requests/minute |
Enterprise | Custom |
X-V2-RateLimit-Limit
X-V2-RateLimit-Remaining
X-V2-RateLimit-Used
X-V2-RateLimit-Reset
Response Format
Article Object:_id
: Unique article identifiertitle
: Article titleurl
: Source URLdate
: Publication date (ISO 8601)importanceScore
: Market importance (1-10)category
: News categorysymbols
: Associated stock symbols (array)sentiment
: Sentiment analysis resultcontent
: Article content or summary (optional; may be absent)koContent
: Korean content or summary (optional; may be absent)