RanglerDeveloper
Get Started

Quickstart

Get your API key and make your first request in under five minutes.

1. Get an API key

Sign in at portal.rangler.co and create an organization. Then generate a sandbox API key.

The key is shown once. Copy it to your secret manager or .env file immediately.

2. Pick your integration path

Start with webhooks for production event delivery. Use event feeds for initial history and checks for missed deliveries.

See Webhooks and Event Feeds for the trade-offs, and SDKs if you want a typed client instead of raw HTTP.

2a. Pick a workflow package

Start with a workflow, not a raw endpoint list. Fund Monitoring covers NAV, disclosures, and fund updates. Issuer Monitoring covers filings, dividends, and board changes.

3. Make your first request

curl -sG https://sandbox-api.rangler.co/v1/financials/statements \
  -H "X-API-Key: rgl_test_your_key_here" \
  --data-urlencode "ticker=ACCESSCORP" \
  --data-urlencode "country_code=NG" \
  --data-urlencode "granularity=annual" \
  --data-urlencode "include_sources=false" | python3 -m json.tool
curl -s https://sandbox-api.rangler.co/v1/filings?limit=5 \
  -H "X-API-Key: rgl_test_your_key_here" | python3 -m json.tool
curl -s https://sandbox-api.rangler.co/v1/funds?limit=5 \
  -H "X-API-Key: rgl_test_your_key_here" | python3 -m json.tool
curl -s "https://sandbox-api.rangler.co/v1/events?limit=10" \
  -H "X-API-Key: rgl_test_your_key_here" | python3 -m json.tool

Responses are JSON. Errors follow Errors.

The Financials example requires a paid organization with the data scope. A sandbox key still observes the organization's plan entitlement.

4. Explore the data

Try:

EndpointWhat it returns
GET /v1/financials/statements?ticker=ACCESSCORP&country_code=NGStandardized financial statements, ratios, and optional filing sources
GET /v1/companiesListed companies with market, sector, and ticker
GET /v1/companies/{id}/filingsFilings for a specific company
GET /v1/funds/{id}Fund detail with latest_snapshot (most recent NAV) and latest_holdings_snapshot (most recent disclosure with holdings)
GET /v1/funds/{id}/snapshotsHistorical fund snapshots with month-over-month and year-over-year deltas
GET /v1/events?type=dividend.declaredFilter the event feed by type

See Financial data, Response Conventions, and the API Reference for details.

5. Add Rangler SDKs

Use ranglerpy for webhook verification, typed event parsing, duplicate-delivery helpers, and API reads. See SDKs. Production receivers still require shared, durable storage for processed event IDs.

6. Receive events via webhook

For webhooks:

Register a webhook endpoint

Create the endpoint in the portal and point it at the receiver URL you want to validate.

Send a test ping

Validate transport and signing before you subscribe to live traffic.

Create an event subscription

Filter by event type, company, or fund.

Receive signed deliveries

Rangler sends matching events with retries and HMAC signatures.

See Webhooks for delivery behavior and signature verification, and Events for event types and their payload format.

6a. Test in sandbox before you go live

Use Sandbox Testing for managed test events, signature verification, delivery inspection, and checks for missed events.

7. Go live

For production:

Generate a live key

Create an rgl_live_ key and keep it separate from sandbox.

Switch to the live base URL

Use https://api.rangler.co/v1.

Review webhook targets and subscriptions

Webhook endpoints and subscriptions are managed at the organization level. Confirm the receiver URL and rules before enabling live traffic.

Handle rate limits cleanly

Back off on 429 responses. See Errors.

API keys and API traffic are isolated by environment. Webhook configuration is managed at the organization level. See Environments.

FAQ

On this page