Skip to main content

Get Started in 5 Minutes

Prerequisites

REST API is available on all plans. See pricing for rate limits and features.

Step 1: Get Your API Key

  1. Login to Byul API Dashboard
  2. Your API key is automatically generated and displayed
  3. Copy your API key (starts with byul_v2)

Step 2: Make Your First Request

Step 3: Parse the Response

Step 4: Handle Pagination

Congratulations!

You’ve successfully made your first REST API request and retrieved financial news!

What’s Next?

Authentication

Learn about API key management and security

Filtering News

Filter news by importance, symbols, and categories

Data Format

Understand the complete news article structure

Error Handling

Handle API errors and rate limits properly

Troubleshooting

Common Issues

401 Unauthorized
  • Check your API key format (must start with byul_)
  • Verify your API key at Dashboard
  • Ensure the X-API-Key header is set correctly
429 Too Many Requests
  • You’ve exceeded your plan’s rate limit
  • Check rate limit headers in the response
  • Implement exponential backoff retry logic
  • Consider upgrading your plan at Pricing
400 Bad Request
  • Check parameter values (limit: 1-100, minImportance: 1-10)
  • Ensure proper URL encoding for query parameters
  • Validate JSON structure if sending request body

Need Help?

Pro Tip: Use environment variables in production instead of hardcoding API keys:

Rate Limits by Plan

  • Test (Free): 30 requests/minute
  • Starter ($19/month): 60 requests/minute
  • Pro ($99/month): 120 requests/minute
  • Enterprise: Custom limits
All responses include rate limit headers for monitoring usage.