Overview

​

REST API

​

Features

• Financial news data access
• Importance scoring (1-10)
• Symbol-based filtering
• Cursor-based pagination
• Real-time updates

​

Authentication

X-API-Key: byul_api_key

​

Quick Example

curl -X GET "https://api.byul.ai/api/v2/news?limit=5&minImportance=8" \
  -H "X-API-Key: byul_api_key"

{
  "items": [
    {
      "_id": "67850d7b0123456789abcdef",
      "title": "Federal Reserve Raises Interest Rates by 0.25%",
      "koTitle": "연준, 기준금리 0.25% 인상",
      "url": "https://www.byul.ai/news/fed-rate-decision-2024",
      "date": "2024-01-15T14:00:00.000Z",
      "importanceScore": 9,
      "category": "central_banks",
      "symbols": ["DXY", "SPY"],
      "sentiment": "neutral"
    }
  ],
  "nextCursor": "67850d7b0123456789abcde0",
  "hasMore": true
}

​

Endpoints

​

GET /news

• 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

​

Rate Limits

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

​

Response Format

• _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

​

Next Steps