Skip to main content
Build Parallax’s institutional-grade analytics directly into your applications using our REST API.

Getting Started

1

Get Your API Key

Contact [email protected] to request API access and receive your credentials.
2

Make Your First Request

Test your connection with a simple authenticated request:
curl -X GET "https://api.chicago.global/v1/health" \
  -H "Authorization: Bearer YOUR_API_KEY"
3

Explore the API

Review our API Reference for complete endpoint documentation.

Core Capabilities

Authentication

All API requests require a Bearer token:
Authorization: Bearer YOUR_API_KEY
Keep your API key secure. Never expose it in client-side code or public repositories.

Async Job Processing

Long-running operations like portfolio analysis use async processing:
// 1. Submit the request
const response = await fetch('https://api.chicago.global/v1/portfolio/analyze', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    holdings: [
      { ticker: 'AAPL', weight: 0.25 },
      { ticker: 'MSFT', weight: 0.25 },
      { ticker: 'GOOGL', weight: 0.25 },
      { ticker: 'AMZN', weight: 0.25 }
    ]
  })
});

const { job_id, check_url } = await response.json();

// 2. Poll for completion
let result;
while (!result) {
  const status = await fetch(check_url, {
    headers: { 'Authorization': `Bearer ${API_KEY}` }
  }).then(r => r.json());

  if (status.status === 'completed') {
    result = status.result;
  } else if (status.status === 'failed') {
    throw new Error(status.error);
  } else {
    await new Promise(r => setTimeout(r, 3000)); // Wait 3 seconds
  }
}

// 3. Use the results
console.log(result.factor_scores);
console.log(result.risk_metrics);

Response Codes

CodeDescription
200Success
401Unauthorized - Invalid or missing API key
404Not found
422Validation error - Check request body
500Server error

Example Use Cases

Build a dashboard that tracks portfolio factor exposures over time:
  1. Store portfolio holdings in your database
  2. Call /v1/portfolio/analyze daily or on-demand
  3. Track changes in factor scores and risk metrics
  4. Alert when exposures drift beyond thresholds
Generate white-labeled reports for clients:
  1. Fetch portfolio analysis via API
  2. Combine with your branding and commentary
  3. Export as PDF or embed in client portal
Integrate factor scores into your stock selection process:
  1. Screen universe with your criteria
  2. Fetch Parallax scores for candidates
  3. Rank by multi-factor composite score
  4. Apply to portfolio construction

Rate Limits

Contact [email protected] for rate limit information based on your plan.

Next Steps