API

Programmatic access to the open context graph for structured finance.

Three endpoints to start integrating today:

# Get all entities
GET https://api.dealcharts.org/entities

# 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

1. Overview

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

Early access is available now for enterprise and partner users. Public API endpoints are launching soon.

2. Access Tiers

3. Example Endpoints

# Get all entities
GET https://api.dealcharts.org/entities

# 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.",
  "entity_type": "issuer",
  "linked_deals": ["CMBS2024-DR1", "CMBS2023-DR2"],
  "last_updated": "2025-09-01T00:00:00Z"
}

4. Authentication

Enterprise and partner users receive API tokens tied to their account. Tokens enforce role-based permissions and rate limits.

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:

• Enterprise Users: Email partnerships@dealcharts.org

• Partners & Integrators: Email partnerships@dealcharts.org

• General Inquiries: Email dev@dealcharts.org

5. Data Model Overview

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 → Community corrections and data contributions
• Provenance → Every record includes author, source, timestamp

All API responses include provenance metadata showing data lineage and source information.

ODPS (Open Data Product Specification)

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

6. Rate Limits & Fair Use

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

• Public tier: 100 requests/hour (when available)
• Enterprise 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

7. Attribution & Licensing

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

• Data quality indicators

• Author/contributor (when applicable)

8. Roadmap

• Q4 2025 — Pilot access for enterprise users
• Q1 2026 — Community write API for corrections
• 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 data updates
• Bulk export endpoints with pagination and filtering
• Context Creation API for submitting community contributions
• Embedding endpoints for chart/widget integration

See our full Roadmap for details.

9. Contact

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

Get Started

Ready to build with Dealcharts data?

1. Explore the platform — Browse deals, entities, and charts
2. Request API access — Email partnerships@dealcharts.org with your use case
3. Receive credentials — Get your API key and documentation
4. Start building! — Integrate Dealcharts into your applications

For partnership or custom integration inquiries, contact us.