Table of Contents

GET /openapi/v1.json

Returns the API's OpenAPI 3.1 document. It describes every endpoint, its parameters, its request and response bodies and its errors. It takes no request body and requires no API key.

Use it to import the API into a tool such as Postman, or to generate a client. The API Reference page shows the same document.

Request

curl https://api.alchemy.example/openapi/v1.json

Response

200 OK with the OpenAPI document as JSON. It begins:

{
  "openapi": "3.1.1",
  "info": {
    "title": "Alchemy API",
    "version": "1.0.0"
  },
  "paths": {

The document names no server. Use it with the base URL you call the API on.