Skip to main content

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 symbol
  • q (string): Search query
  • cursor (string): Pagination cursor
  • category (string): News category filter
  • startDate (string): Start of date range (ISO 8601)
  • endDate (string): End of date range (ISO 8601)

Rate Limits

Headers:
  • X-V2-RateLimit-Limit
  • X-V2-RateLimit-Remaining
  • X-V2-RateLimit-Used
  • X-V2-RateLimit-Reset

Response Format

Article Object:
  • _id: Unique article identifier
  • title: Article title
  • url: Source URL
  • date: Publication date (ISO 8601)
  • importanceScore: Market importance (1-10)
  • category: News category
  • symbols: Associated stock symbols (array)
  • sentiment: Sentiment analysis result
  • content: Article content or summary (optional; may be absent)
  • koContent: Korean content or summary (optional; may be absent)

Next Steps

Quickstart

Get started with REST API requests

Examples

Code examples in multiple languages

Authentication

API key setup and security

Error Handling

Handle API errors and status codes