Profitelligence API

Developer Resource: This documentation covers the Profitelligence REST API for programmatic access to market intelligence. For platform usage guides, see Getting Started.

Overview

The Profitelligence API provides access to the same data and analytics that power our platform:

• Company Data — Profiles, OHLC prices, technical signals
• SEC Filings — 8-K analysis with AI-generated summaries and impact scoring
• Form 4 Insider Trading — Transactions, clusters, analytics, and sentiment signals
• FRED Economic Data — Macro indicators and yield curve data
• Quantitative Analytics — Correlations, opportunity scores, and pattern signatures

All endpoints return clean, structured data suitable for integration into trading systems, research tools, or custom dashboards.

Base URLs

All requests use HTTPS. HTTP requests are rejected.

Authentication

The API supports two authentication methods:

Firebase JWT (User Authentication)

For web and mobile applications where users log in:

    
    Authorization: Bearer 

  

JWT tokens are obtained through Firebase Authentication and automatically include user subscription tier information.

API Key (Server-to-Server)

For backend services and automated systems:

    
    X-API-Key: 

  

API keys are tied to your account and subject to rate limits based on subscription tier.

See: Authentication Guide for detailed setup instructions.

Response Formats

CSV (Default)

Most endpoints return pipe-delimited CSV for efficient data transfer:

    
    symbol|date|open|high|low|close|volume
AAPL|2024-01-15|185.50|186.74|184.92|186.19|45234567
AAPL|2024-01-16|186.09|187.05|185.30|186.86|42891234

  

Why CSV?

• Smaller payload sizes
• Faster parsing in data pipelines
• Direct compatibility with pandas, Excel, and databases

JSON (Explicit Paths)

Complex, nested responses use JSON. These endpoints include:

• Page aggregation routes (/company-info-page, /form4-company-page)
• Analytics endpoints (/analytics/*)
• FRED economic data (/fred-*)

JSON responses follow standard structure:

    
    {
  "data": { ... },
  "meta": {
    "timestamp": "2024-01-15T14:30:00Z",
    "cached": false
  }
}

  

Subscription Tiers & Access

Data access varies by subscription level:

Requests for symbols outside your tier return a 403 Forbidden response with details about upgrading.

Quick Start

1. Get Your Credentials

For JWT auth: Use the Firebase SDK to authenticate users in your app.

For API key: Contact us to request API access for your account.

2. Make Your First Request

    
    # Get company profile for Apple
curl -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  "https://apollo.profitelligence.com/v1/company-profile?symbol=AAPL"

  

3. Parse the Response

    
    cik|ticker|company_name|sector|industry|exchange|market_cap|employees
320193|AAPL|Apple Inc.|Technology|Consumer Electronics|NASDAQ|2850000000000|164000

  

Endpoint Categories

Company Data

Core company information and market data.

See: Company Data Endpoints

Form 4 Insider Trading

Comprehensive insider transaction data and analytics.

See: Form 4 Endpoints

FRED Economic Data

Federal Reserve economic indicators.

See: FRED Endpoints

Advanced Analytics

Quantitative analysis and pattern recognition.

See: Analytics Endpoints

Error Handling

All errors return appropriate HTTP status codes with descriptive messages:

    
    {
  "error": "Symbol not found",
  "code": "SYMBOL_NOT_FOUND",
  "details": "The symbol 'INVALID' does not exist in our database"
}

  

Rate Limiting

Rate limits are enforced per API key or user account:

• Daily limit: Resets at midnight UTC
• Hourly limit: Rolling 60-minute window

When rate limited, the response includes headers:

    
    X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1705334400

  

Best practices:

• Cache responses when possible
• Use page aggregation endpoints to reduce call count
• Implement exponential backoff on 429 responses

SDKs & Libraries

We recommend using standard HTTP libraries for API access:

Python:

    
    import requests

headers = {"Authorization": f"Bearer {jwt_token}"}
response = requests.get(
    "https://apollo.profitelligence.com/v1/company-profile",
    params={"symbol": "AAPL"},
    headers=headers
)

  

JavaScript:

    
    const response = await fetch(
  'https://apollo.profitelligence.com/v1/company-profile?symbol=AAPL',
  { headers: { 'Authorization': `Bearer ${jwtToken}` } }
);

  

Changelog

API changes are documented here. We maintain backward compatibility and provide deprecation notices for breaking changes.

Support

Questions about the API?

• Check endpoint-specific documentation
• Review error messages (they're designed to be helpful)
• Contact support for API key issues

Found a bug?

• Include the full request URL (without credentials)
• Include the response body and status code
• Note the approximate timestamp

Next Steps

Ready to start building? Head to the Authentication Guide to set up your credentials, then explore the endpoint documentation for the data you need.