REST reference

Soon[2 endpoints]View as Markdown

CMBS

Commercial mortgage-backed securities — deal registry and loan/property collateral detail from public SEC EDGAR ABS-EE EX-102 filings.

Paths are relative to https://api.agentdatasets.com. Every endpoint mirrors an MCP tool over the same service layer — the tool catalog documents the same operations for MCP clients.

GET/v1/cmbs/deals

Deals

Return registered CMBS deals and their asset-data coverage.

Parameters

NameTypeRequiredDefaultConstraintsDescription
querystring | nullNoCase-insensitive trust-name substring
filed_afterstring (date) | nullNoInclusive latest asset-data filing-date lower bound
limitintegerNo10min 1, max 50Registered deals per page
cursorstring | nullNoOpaque pagination.next_cursor from the previous response

Example request

Required parameters only, with values taken from the schema. Optional parameters are in the table above.

[ BASH ]
curl --fail --silent --show-error \
  --header "X-API-KEY: adk_..." \
  "https://api.agentdatasets.com/v1/cmbs/deals"

Response

200 Successful Response · expand a branch to see its fields.

  • dataSearchDealsDatarequiredApplied search context and a bounded page of CMBS deals.
    • querystringrequirednullable
    • filed_afterstring (date)requirednullable
    • dealsarray<DealSummary>required
      • cikintegerrequired
      • trust_namestringrequired
      • latest_filed_datestring (date)required
      • first_asset_filing_datestring (date)requirednullable
      • latest_asset_filing_datestring (date)requirednullable
      • loan_countintegerrequirednullable
  • metaMetarequiredResult-level provenance. ``source`` is a stable connector identifier (e.g. ``sec_edgar_companyfacts``); ``as_of`` is the freshest value-level ``as_of`` on the returned page, or ``None`` when the page is empty. Event-grained sources carry an aware datetime; date-grained sources (e.g. an SEC filing's report period) carry a plain date.
    • sourcestringrequired
    • as_ofstring (date-time) | string (date)nullable
  • paginationPaginationnullable
    • limitintegerrequired
    • has_morebooleanrequired
    • next_cursorstringnullable

GET/v1/cmbs/loans

Loans

Return one CMBS deal's loans with collateral and latest performance.

Parameters

NameTypeRequiredDefaultConstraintsDescription
dealstringYesmin length 1Exact CMBS trust name or all-digits CIK
property_typestring | nullNomin length 1Exact SEC property-type code
statestring | nullNomin length 2, max length 22-letter property state code
payment_statusstring | nullNomin length 1Exact latest-period payment-status code
limitintegerNo25min 1, max 100Prospectus loan-ID-order loans per page
cursorstring | nullNoOpaque pagination.next_cursor from the previous response

Example request

Required parameters only, with values taken from the schema. Optional parameters are in the table above.

[ BASH ]
curl --fail --silent --show-error \
  --header "X-API-KEY: adk_..." \
  "https://api.agentdatasets.com/v1/cmbs/loans?deal=DEAL"

Response

200 Successful Response · expand a branch to see its fields.

  • dataGetLoansDatarequiredResolved deal, applied filters, and a bounded page of filed loans.
    • cikintegerrequired
    • trust_namestringrequired
    • property_typestringrequirednullable
    • statestringrequirednullable
    • payment_statusstringrequirednullable
    • loansarray<LoanRecord>required
      • asset_numberstringrequired
      • asset_sequenceintegerrequired
      • asset_type_numberstringrequirednullable
      • originator_namestringrequirednullable
      • origination_datestring (date)requirednullable
      • original_loan_amountNumericValuerequirednullable
        • valuestringrequired
        • unitstringrequired
        • currency"USD"requirednullable
        • accession_numberstringrequired
        • as_ofstring (date-time)requirednullable
      • original_term_monthsintegerrequirednullable
      • maturity_datestring (date)requirednullable
      • original_amortization_term_monthsintegerrequirednullable
      • original_interest_rateNumericValuerequirednullable
        • valuestringrequired
        • unitstringrequired
        • currency"USD"requirednullable
        • accession_numberstringrequired
        • as_ofstring (date-time)requirednullable
      • original_interest_rate_type_codestringrequirednullable
      • original_interest_only_term_monthsintegerrequirednullable
      • first_payment_due_datestring (date)requirednullable
      • payment_type_codestringrequirednullable
      • interest_only_indicatorbooleanrequirednullable
      • balloon_indicatorbooleanrequirednullable
      • negative_amortization_indicatorbooleanrequirednullable
      • modified_indicatorbooleanrequirednullable
      • number_propertiesintegerrequirednullable
      • number_properties_securitizationintegerrequirednullable
      • latest_seen_accessionstringrequired
      • as_ofstring (date-time)requirednullable
      • propertiesarray<PropertyRecord>required
        • property_namestringrequirednullable
        • property_type_codestringrequirednullable
        • addressstringrequirednullable
        • citystringrequirednullable
        • statestringrequirednullable
        • zipstringrequirednullable
        • countystringrequirednullable
        • geographyPropertyGeographynullable
          • geo_keystringrequiredCanonical property geography key. Pass it to re_search_geographies when the weighted county split for a ZCTA is needed.
          • levelstringrequiredCanonical geography level (`zcta` or `state`).
          • namestringrequiredCanonical Census geography name.
          • resolution"zip" | "state"required`zip` for an exact ZCTA match; `state` for state-only fallback.
          • state_geo_keystringrequirednullableCanonical state pivot key.
          • county_geo_keystringrequirednullableDominant county for the property's ZCTA by largest land-area overlap in the Census ZCTA-to-county relationship file. A ZCTA can span counties; call re_search_geographies with geo_key for the weighted split.
          • county_namestringrequirednullableName of the dominant county for the property's ZCTA by largest Census land-area overlap; it is not a claim that the ZCTA lies wholly in one county.
          • cbsa_geo_keystringrequirednullableOMB-delineated CBSA pivot for the ZCTA's dominant county.
          • cbsa_namestringrequirednullableOMB-delineated CBSA name for the ZCTA's dominant county.
        • net_rentable_sqftNumericValuerequirednullable
          • valuestringrequired
          • unitstringrequired
          • currency"USD"requirednullable
          • accession_numberstringrequired
          • as_ofstring (date-time)requirednullable
        • units_beds_roomsintegerrequirednullable
        • year_builtintegerrequirednullable
        • most_recent_valuation_amountNumericValuerequirednullable
          • valuestringrequired
          • unitstringrequired
          • currency"USD"requirednullable
          • accession_numberstringrequired
          • as_ofstring (date-time)requirednullable
        • most_recent_valuation_datestring (date)requirednullable
        • most_recent_valuation_source_codestringrequirednullable
        • occupancy_securitization_pctNumericValuerequirednullable
          • valuestringrequired
          • unitstringrequired
          • currency"USD"requirednullable
          • accession_numberstringrequired
          • as_ofstring (date-time)requirednullable
        • most_recent_occupancy_pctNumericValuerequirednullable
          • valuestringrequired
          • unitstringrequired
          • currency"USD"requirednullable
          • accession_numberstringrequired
          • as_ofstring (date-time)requirednullable
        • most_recent_financials_start_datestring (date)requirednullable
        • most_recent_financials_end_datestring (date)requirednullable
        • noi_securitization_amountNumericValuerequirednullable
          • valuestringrequired
          • unitstringrequired
          • currency"USD"requirednullable
          • accession_numberstringrequired
          • as_ofstring (date-time)requirednullable
        • most_recent_noi_amountNumericValuerequirednullable
          • valuestringrequired
          • unitstringrequired
          • currency"USD"requirednullable
          • accession_numberstringrequired
          • as_ofstring (date-time)requirednullable
        • ncf_securitization_amountNumericValuerequirednullable
          • valuestringrequired
          • unitstringrequired
          • currency"USD"requirednullable
          • accession_numberstringrequired
          • as_ofstring (date-time)requirednullable
        • most_recent_ncf_amountNumericValuerequirednullable
          • valuestringrequired
          • unitstringrequired
          • currency"USD"requirednullable
          • accession_numberstringrequired
          • as_ofstring (date-time)requirednullable
        • dscr_noi_securitizationNumericValuerequirednullable
          • valuestringrequired
          • unitstringrequired
          • currency"USD"requirednullable
          • accession_numberstringrequired
          • as_ofstring (date-time)requirednullable
        • dscr_ncf_securitizationNumericValuerequirednullable
          • valuestringrequired
          • unitstringrequired
          • currency"USD"requirednullable
          • accession_numberstringrequired
          • as_ofstring (date-time)requirednullable
        • most_recent_dscr_noiNumericValuerequirednullable
          • valuestringrequired
          • unitstringrequired
          • currency"USD"requirednullable
          • accession_numberstringrequired
          • as_ofstring (date-time)requirednullable
        • most_recent_dscr_ncfNumericValuerequirednullable
          • valuestringrequired
          • unitstringrequired
          • currency"USD"requirednullable
          • accession_numberstringrequired
          • as_ofstring (date-time)requirednullable
        • most_recent_dscr_codestringrequirednullable
        • accession_numberstringrequired
        • as_ofstring (date-time)requirednullable
      • latest_periodPeriodRecordrequirednullable
        • reporting_period_begin_datestring (date)requirednullable
        • reporting_period_end_datestring (date)required
        • begin_scheduled_balanceNumericValuerequirednullable
          • valuestringrequired
          • unitstringrequired
          • currency"USD"requirednullable
          • accession_numberstringrequired
          • as_ofstring (date-time)requirednullable
        • end_actual_balanceNumericValuerequirednullable
          • valuestringrequired
          • unitstringrequired
          • currency"USD"requirednullable
          • accession_numberstringrequired
          • as_ofstring (date-time)requirednullable
        • end_scheduled_balanceNumericValuerequirednullable
          • valuestringrequired
          • unitstringrequired
          • currency"USD"requirednullable
          • accession_numberstringrequired
          • as_ofstring (date-time)requirednullable
        • period_interest_rateNumericValuerequirednullable
          • valuestringrequired
          • unitstringrequired
          • currency"USD"requirednullable
          • accession_numberstringrequired
          • as_ofstring (date-time)requirednullable
        • paid_through_datestring (date)requirednullable
        • payment_status_codestringrequirednullable
        • primary_servicer_namestringrequirednullable
        • most_recent_special_servicer_transfer_datestring (date)requirednullable
        • most_recent_master_servicer_return_datestring (date)requirednullable
        • asset_added_indicatorbooleanrequirednullable
        • modification_indicatorbooleanrequirednullable
        • nonrecoverability_indicatorbooleanrequirednullable
        • total_pi_advanced_outstandingNumericValuerequirednullable
          • valuestringrequired
          • unitstringrequired
          • currency"USD"requirednullable
          • accession_numberstringrequired
          • as_ofstring (date-time)requirednullable
        • accession_numberstringrequired
        • as_ofstring (date-time)requirednullable
  • metaGetLoansMetarequiredCMBS loan provenance with conditional Census/OMB derivation notice.
    • sourcestringrequired
    • as_ofstring (date-time) | string (date)nullable
    • noticestringnullable
  • paginationPaginationnullable
    • limitintegerrequired
    • has_morebooleanrequired
    • next_cursorstringnullable