Back to Overview

Getting Started

Make your first API call in under 5 minutes

1

Authentication

All API requests require an API key in the header. You can find your key in the portal.

X-API-Key: your_api_key_here
2

Base URL

All API endpoints are accessed via HTTPS at our base URL.

https://api.rize.capital
3

Your First Request

Let's get the latest news for Apple. This request returns immediately with AI-curated news.

curl -X POST https://api.rize.capital/api/products/news \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"symbols": ["AAPL"], "n": 3}'
4

Understanding Responses

Responses come in two patterns: immediate (cached) or asynchronous (processing).

Immediate Response (Cached)

{
  "job_id": "abc-123",
  "status": "completed",
  "from_cache": true,
  "news": [...]  // Your data is here
}

Asynchronous Response (Processing)

{
  "job_id": "xyz-456",
  "status": "pending",
  "from_cache": false,
  "status_url": "/api/jobs/news/xyz-456/status",
  "result_url": "/api/jobs/news/xyz-456/result"
}

Poll the status_url until status is "completed", then fetch from result_url

Common Patterns

Polling for Results

// Poll every 2 seconds
async function pollForResult(statusUrl) {
  let status = 'pending';
  while (status === 'pending') {
    await sleep(2000);
    const res = await fetch(statusUrl, {
      headers: {'X-API-Key': apiKey}
    });
    const data = await res.json();
    status = data.status;
  }
  return data;
}

Error Handling

try {
  const response = await fetch(url, options);
  if (!response.ok) {
    const error = await response.json();
    throw new Error(error.detail);
  }
  return await response.json();
} catch (error) {
  console.error('API Error:', error.message);
}

Rate Limits

News API

100 requests/minute

Analysis API

20 requests/minute

Chat API

10 concurrent streams

Rate limit headers are included in all responses: X-RateLimit-Remaining and X-RateLimit-Reset

What's Next?

Now that you've made your first request, explore our products:

View Full API Reference →