API

Programmatic access to the open context graph for structured finance.

The Dealcharts API provides structured access to verified context — entities, deals, filings, charts, and relationships — derived from public data and enhanced by the community.

Early access is available to Verified Entities and Verified Contributors.

# Get all verified entities
GET https://api.dealcharts.org/entities?verified=true

# Retrieve details for a specific deal
GET https://api.dealcharts.org/deals/{deal_id}

# Get charts for an entity
GET https://api.dealcharts.org/entities/{entity_id}/charts

# Search for filings mentioning an entity
GET https://api.dealcharts.org/search?q=Digital%20Realty

Response example:

{
  "entity_id": "cm1234",
  "name": "Digital Realty Trust, Inc.",
  "verified": true,
  "linked_deals": ["CMBS2024-DR1", "CMBS2023-DR2"],
  "last_updated": "2025-09-01T00:00:00Z"
}

Verified participants will receive API tokens tied to their account. Tokens enforce role-based permissions (read, annotate, submit corrections).

Example usage:

# Include your API key in the Authorization header
curl -H "Authorization: Bearer YOUR_API_KEY" \
     https://api.dealcharts.org/entities/your-entity-id

To request API access:

• Verified Entities: Email verified@dealcharts.org
• Verified Contributors: Email contributors@dealcharts.org
• Partners: Email partnerships@dealcharts.org

Dealcharts' API surfaces the same relationships visible on the site:

• Entities → Issuers, Servicers, Funds
• Deals → Tranches, Shelves, Counterparties
• Charts → Generated views of structured data
• Submissions → Verifications, Corrections, Links
• Provenance → Every record includes author, source, timestamp

All API responses include provenance metadata showing data lineage and verification status.

Each Dealcharts dataset includes a machine-readable descriptor (ODPS v4) with owner, access, SLA, quality, schema, and distribution info.
Start here:

• CMBS Deals ODPS →

  /odps/cmbs-deals.yaml

Public endpoints will include moderate rate limits. Verified and Partner tiers may request expanded quotas for integration and analysis.

• Public tier: 100 requests/hour (when available)
• Verified tier: 1,000 requests/hour
• Partner tier: Custom limits by agreement

All responses include rate limit headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 987
X-RateLimit-Reset: 1642521600

All API usage must:

• Attribute as "Source: Dealcharts.org" with link back to relevant pages
• Preserve provenance metadata in downstream applications
• Review our Attribution Guidelines

Commercial redistribution requires prior approval.

Every API response includes provenance metadata showing:

• Original data source (e.g., SEC accession number)
• Last updated timestamp
• Verification status
• Author/contributor (when applicable)

• Q4 2025 — Pilot access for Verified Entities
• Q1 2026 — Contributor write API
• Q2 2026 — Open read endpoints + key-based authentication
• Q3 2026 — Partner integrations via CMD+RVL Context Engine

Additional upcoming features:

• GraphQL endpoint for flexible relationship queries
• Webhooks for real-time updates to verified profiles
• Bulk export endpoints with pagination and filtering
• Context Creation API for submitting verified contributions
• Embedding endpoints for chart/widget integration

See our full Roadmap for details.

Interested in access or integration?

→ dev@dealcharts.org

Other contacts:

• API Status: status.dealcharts.org (coming soon)
• Developer Forum: /community
• General Inquiries: /contact

Full API documentation will be available at

https://docs.dealcharts.org

Ready to build with Dealcharts data?

1. Verify your entity or become a contributor
2. Request API access via email
3. Receive your API key and documentation
4. Start building!

For partnership or custom integration inquiries, contact us.