Skip to main content
The Turtle Earn API publishes a machine-readable OpenAPI 3.1 specification. Use it to browse every public endpoint, generate a typed client, or drive an interactive playground. Spec URL: https://earn.turtle.xyz/docs/openapi.json

​
Browse the endpoints

The hosted Swagger UI lists every public endpoint with its parameters, request bodies, and response schemas: The endpoints documented in this section (Authentication, Opportunities, Earn, Portfolio & Activity, Streams) are the partner-facing surface of that spec.

​
Import into a client

Point any OpenAPI-aware tool at the spec URL:
  • Postman or Insomnia: import by URL for an interactive collection.
  • Swagger UI or Redoc, locally: load the spec URL to browse offline.

​
Generate a typed client

npx @openapitools/openapi-generator-cli generate \
  -i https://earn.turtle.xyz/docs/openapi.json \
  -g typescript-fetch \
  -o ./turtle-client
After generating, configure the client with your X-API-Key header. See API Keys.
The spec is generated from the live API and reflects only the public endpoints. For the raw URL and more client-generation detail, see OpenAPI Spec.