The reference is generated from the same contract the API is built from, so it always matches what the API accepts and returns. Pick an endpoint in the sidebar to see its parameters and responses, and to send a test request.

Base URL

https://public.api.paragraph.com/api

Endpoints with an Authorization section take your API key as a Bearer token. See Authentication for how to get one.

Pagination

List endpoints are cursor-based. Pass limit to set the page size, then pass the cursor from the previous response's pagination to get the next page. pagination.hasMore is false on the last page.

Errors

Failed requests return a non-2xx status with a JSON body:

{ "success": false, "msg": "Post not found" }

msg is written to be shown to a person, so it's safe to surface in your app or pass back to an agent.

OpenAPI spec

The full spec is at docs.paragraph.com/openapi.json. Use it to generate a client in another language or to load the API into tools like Postman.

On this page