Skip to content

Add OpenAPI 3.1 spec for the Public API v1#1

Open
pimfeltkamp wants to merge 1 commit intomainfrom
openapi-spec
Open

Add OpenAPI 3.1 spec for the Public API v1#1
pimfeltkamp wants to merge 1 commit intomainfrom
openapi-spec

Conversation

@pimfeltkamp
Copy link
Copy Markdown

Summary

  • New file: `openapi/cryptohopper.yaml` — OpenAPI 3.1 spec covering all 18 public API domains (~150 endpoints) the official SDKs wrap.
  • New file: `openapi/README.md` — how to use it (Redocly / Swagger UI / Postman import / codegen), scope vs out-of-scope, SDK links.

Why

Checks off roadmap item D1 in the SDK-suite roadmap: give third-party developers a single authoritative spec they can load into tooling or code-generate from for languages we don't ship an SDK for.

Scope

Included: `user`, `hoppers`, `exchange`, `strategy`, `backtest`, `market`, `signals`, `arbitrage`, `marketmaker`, `template`, `ai`, `platform`, `chart`, `subscription`, `social`, `tournaments`, `webhooks`, `app`.

Excluded (matches SDK scope):

  • SiteAPI (session-based internal API)
  • Mobile device-id auth flow (internal)
  • HMAC request signing (partner-only)
  • Signal webhook publishing (distinct auth model)

Test plan

  • `npx @redocly/cli lint openapi/cryptohopper.yaml` (validate)
  • Preview in Redocly / Swagger UI and spot-check 2–3 endpoints against live behaviour
  • Import into Postman; send a `GET /user/get` with a real token; verify 200 + response shape matches

🤖 Generated with Claude Code

Covers all 18 public API domains (~150 endpoints) — hand-maintained,
mirrors the handwritten surface of the five official SDKs
(Node/Python/Go/Ruby/Rust + CLI).

Meant as the contract doc for:
- Redocly / Swagger UI / Stoplight Elements hosted references
- Postman / Insomnia / Bruno collection imports
- Code generation for languages we don't ship an SDK for
  (note: the official SDKs themselves are handwritten, not generated
  from this spec, for idiomatic surfaces per language)

Out of scope (matching the SDKs): SiteAPI, mobile device-id flow,
HMAC request signing (partner-only), and signal-webhook publishing.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant