Skip to content

API.md

Latest commit

 

History

History
95 lines (73 loc) · 3.81 KB

API.md

File metadata and controls

95 lines (73 loc) · 3.81 KB

API Reference

Base URL: https://warn.forgemesh.io

Disruption Intelligence exposes public discovery and preview routes alongside x402-priced intelligence routes. The hosted discovery documents are the authoritative current contract:

curl "https://warn.forgemesh.io/openapi.json"
curl "https://warn.forgemesh.io/.well-known/x402.json"

Public Routes

Method Path Output
GET /health Availability and service version metadata.
GET /stats Aggregate reported-event summaries.
GET /sources Public provenance information.
GET /events Bounded event preview; optional state query parameter.
GET /events/recent Bounded preview of recent records.
GET /events/:id Single basic event preview.
GET /company/:name Bounded event preview matched by company name.
GET /state/:state Bounded event preview for a state.
GET /llms.txt Plain-text catalog for agent discovery.
GET /openapi.json Machine-readable API contract.
GET /.well-known/x402.json Machine-readable x402 catalog.

Public event previews may include identifiers, jurisdiction, company name, location, reported employee impact, relevant dates, and action category.

Paid Routes

Paid endpoints return an x402 payment challenge when called without payment authorization.

Method Path Listed price Output
GET /events/:id/severity $0.01 Severity signal and supporting response fields.
GET /events/:id/history $0.02 Event version history.
GET /events/:id/relationships $0.02 Related event links.
GET /events/:id/timeline $0.05 Consolidated event timeline.
GET /events/:id/company-intel $0.03 Company context associated with an event.
GET /companies/search $0.01 Company search results.
GET /companies/:id $0.05 Company intelligence profile.
GET /companies/:id/intelligence $0.05 Company intelligence summary.
GET /radius/:zip $0.05 Geographic event results around a ZIP code.
GET /territory/:zip/disruption $0.10 Territory disruption summary and trend fields.
GET /regions/:state $0.02 Regional summaries within a state.
GET /regions/:state/:county $0.01 Single regional summary.
GET /jurisdictions $0.02 Jurisdiction activity summaries.
GET /jurisdictions/:state $0.01 Single jurisdiction summary.

Listed prices are informational; clients must rely on active payment requirements returned by the hosted service.

Query Parameters

GET /events

Parameter Description
state Optional two-letter state filter.

GET /companies/search

Parameter Description
q Company query string.
limit Requested page size, subject to API limits.
offset Requested result offset.

GET /radius/:zip

Parameter Description
radius Search radius in miles.
limit Requested result count.
from, to ISO-formatted notice-date boundaries.
minEmployees Minimum reported employee impact.
naics Optional industry-code prefix filter.

GET /territory/:zip/disruption

Parameter Description
radius Search radius in miles.
from, to ISO-formatted notice-date boundaries.

Response Statuses

Status Meaning
200 Request completed.
402 Payment authorization is required; inspect x402 response metadata.
404 Requested entity or geographic key was not found.
500 Service could not complete the request.

This public reference documents responses and access patterns only; it does not publish the hosted engine implementation.