Skip to main content

REST API Overview

Introduction​

The Situation Atlas REST API provides programmatic access to your deals and filings. Use it to integrate deal data, SEC 8-K filings, Form 4 insider purchases, and Japan filings with external tools, scripts, or CI pipelines.

Base URL​

https://kc9zu8cyjf.execute-api.us-east-1.amazonaws.com/v1

Authentication​

All requests require an API key passed in the x-api-key header. See Authentication for details on creating and managing API keys.

Rate Limits​

  • 100 requests per second sustained rate
  • 200 requests burst capacity

Response Format​

All responses are JSON. Successful responses return the requested data directly. Error responses follow this format:

{
  "error": "Human-readable error message"
}

HTTP Status Codes​

CodeDescription
200Success
201Created (for POST requests)
400Bad request — invalid or missing parameters
401Unauthorized — missing or invalid API key
403Forbidden — you don't own this resource
404Not found
429Too many requests — rate limit exceeded
500Internal server error

CORS​

The API supports cross-origin requests from any origin. The x-api-key header is allowed in CORS preflight responses.

Available Endpoints​

ResourceEndpoints
DealsGET /deals, GET /deals/{dealId}, POST /deals, PUT /deals/{dealId}
SEC FilingsGET /filings/sec, GET /filings/sec/{filingId}, POST /filings/sec/{filingId}/preferences
Form 4 (Insider Purchases)GET /filings/form4, GET /filings/form4/{filingId}, POST /filings/form4/{filingId}/preferences
Japan FilingsGET /filings/japan, GET /filings/japan/{filingId}, POST /filings/japan/{filingId}/preferences

See the Endpoints page for full details and examples.

Quick Example​

# List your deals
curl -s -H "x-api-key: sa_your_api_key_here" \
  https://kc9zu8cyjf.execute-api.us-east-1.amazonaws.com/v1/deals | jq

# List recent SEC filings
curl -s -H "x-api-key: sa_your_api_key_here" \
  https://kc9zu8cyjf.execute-api.us-east-1.amazonaws.com/v1/filings/sec | jq