Quickstart

# Set your API key
export DEBTSTACK_API_KEY="ds_your_api_key_here"

# Search companies with field selection
curl -H "X-API-Key: $DEBTSTACK_API_KEY" \
  "https://api.debtstack.ai/v1/companies?ticker=AAPL,MSFT,GOOGL&fields=ticker,name,net_leverage_ratio"

import requests

API_KEY = "ds_xxxxx"
BASE_URL = "https://api.debtstack.ai/v1"

response = requests.get(
    f"{BASE_URL}/companies",
    params={
        "ticker": "AAPL",
        "fields": "ticker,name,total_debt,net_leverage_ratio"
    },
    headers={"X-API-Key": API_KEY}
)

data = response.json()
print(data)

const API_KEY = "ds_xxxxx";
const BASE_URL = "https://api.debtstack.ai/v1";

const params = new URLSearchParams({
  ticker: "AAPL",
  fields: "ticker,name,total_debt,net_leverage_ratio"
});

const response = await fetch(`${BASE_URL}/companies?${params}`, {
  headers: { "X-API-Key": API_KEY }
});

const data = await response.json();
console.log(data);

{
  "data": [
    {
      "ticker": "AAPL",
      "name": "Apple Inc.",
      "total_debt": 10650000000000,
      "net_leverage_ratio": 0.8
    }
  ],
  "meta": {
    "total": 1,
    "limit": 50,
    "offset": 0
  }
}

# Find high-yield senior unsecured bonds with pricing data
curl -H "X-API-Key: $DEBTSTACK_API_KEY" \
  "https://api.debtstack.ai/v1/bonds?seniority=senior_unsecured&min_ytm=8.0&has_pricing=true"

# Bonds yielding more than 8%
response = requests.get(
    f"{BASE_URL}/bonds",
    params={
        "min_ytm": 8.0,
        "has_pricing": True,
        "seniority": "senior_unsecured",
        "fields": "name,cusip,company_ticker,coupon_rate,pricing",
        "sort": "-pricing.ytm"
    },
    headers={"X-API-Key": API_KEY}
)

# Map trader shorthand to CUSIP
curl -H "X-API-Key: $DEBTSTACK_API_KEY" \
  "https://api.debtstack.ai/v1/bonds/resolve?q=RIG%208%25%202027"

# Lookup by CUSIP
curl -H "X-API-Key: $DEBTSTACK_API_KEY" \
  "https://api.debtstack.ai/v1/bonds/resolve?cusip=89157VAG8"

# Get trailing twelve months financials for AAPL
curl -H "X-API-Key: $DEBTSTACK_API_KEY" \
  "https://api.debtstack.ai/v1/financials?ticker=AAPL&period=TTM"

# Get all Q3 2025 financials for comparison
curl -H "X-API-Key: $DEBTSTACK_API_KEY" \
  "https://api.debtstack.ai/v1/financials?fiscal_year=2025&fiscal_quarter=3&format=csv"

# Find all first-lien collateral for RIG
curl -H "X-API-Key: $DEBTSTACK_API_KEY" \
  "https://api.debtstack.ai/v1/collateral?ticker=RIG&priority=first_lien"

# Get collateral with valuations
curl -H "X-API-Key: $DEBTSTACK_API_KEY" \
  "https://api.debtstack.ai/v1/collateral?has_valuation=true&collateral_type=equipment"

# Find covenant language in credit agreements
curl -H "X-API-Key: $DEBTSTACK_API_KEY" \
  "https://api.debtstack.ai/v1/documents/search?q=event+of+default&ticker=RIG&section_type=indenture"

# Find covenant language in credit agreements
response = requests.get(
    f"{BASE_URL}/documents/search",
    params={
        "q": "restricted payment dividend",
        "section_type": "indenture",
        "ticker": "RIG"
    },
    headers={"X-API-Key": API_KEY}
)

curl -X POST "https://api.debtstack.ai/v1/entities/traverse" \
  -H "X-API-Key: $DEBTSTACK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"start":{"type":"bond","id":"893830AK8"},"relationships":["guarantees"]}'

# Who guarantees this bond?
response = requests.post(
    f"{BASE_URL}/entities/traverse",
    headers={
        "X-API-Key": API_KEY,
        "Content-Type": "application/json"
    },
    json={
        "start": {"type": "bond", "id": "893830AK8"},
        "relationships": ["guarantees"],
        "direction": "inbound"
    }
)

{
  "data": [...],  // The requested data
  "meta": {
    "total": 100,     // Total matching records
    "limit": 50,      // Page size
    "offset": 0,      // Current offset
    "request_id": "req_abc123"
  }
}

{
  "error": {
    "code": "INVALID_TICKER",
    "message": "Company ticker 'XYZ' not found in database",
    "details": {
      "ticker": "XYZ",
      "suggestion": "Did you mean 'XOM'?"
    }
  }
}