Harpd Answers · Explained
What is Harpd's OpenAPI description?
Harpd publishes an OpenAPI document at /openapi.json describing its public endpoints, so a tool or agent can discover and call the API without reading documentation prose.
Quick answer
What is Harpd's OpenAPI description?
Harpd's OpenAPI document is a machine-readable description of the public HTTP surface: the endpoints, what each returns and the response shapes. It is published at /openapi.json and is the companion to the human-readable reference at /developers/api/.
- Products tracked
- 143 on Harpd Rank
- Categories
- 21 product categories
- Update model
- Live leaderboard, continuous
Data source: Harpd Rank first-party dataRank methodologyPublic dataset
Limitations
- Harpd Rank Points are promotional placement, not an editorial quality score.
- Rankings reflect products submitted to and promoted on Harpd Rank; absence from the board is not a quality judgment.
Data source: Harpd Rank first-party data
How it works
The mechanics, plainly
A client or agent fetches /openapi.json, discovers the available operations, and generates calls or client code from it. The document is generated from the same route definitions the site serves, so it cannot describe an endpoint that does not exist.
How it compares
Harpd vs the traditional approach
| Aspect | Harpd / this model | Traditional |
|---|---|---|
| Audience | Tools, agents and code generators | Human readers |
| Maintenance | Generated from the real routes | Hand-written, drifts |
| Discovery | One fetch lists the whole surface | Read every page |
| Cost | Free, keyless, CC BY 4.0 data | Often gated |
Why it matters
Documentation prose is for people; an OpenAPI document is for software. Publishing both means an engineer can read the reference and an agent can call the API, without either having to translate the other's format.
Frequently asked questions
Does the OpenAPI document cover the paid agent surface?
It describes the public HTTP surface. The x402 agent-payment endpoints are documented separately at /protocols/x402/ and in the Agent Market.
Can I generate a client from it?
Yes. It is a standard OpenAPI document, so any OpenAPI-compatible generator can produce a client for the public endpoints.
Is the API versioned?
Datasets carry a schemaVersion in their envelope, and changes are recorded in /changelog/ so a client can pin what it depends on.