Sherwood API

Quickstart

Base URL: https://api.sherwood.stream. Every /v1/public route is available to guests without an API key. Use the API host directly from your browser or server. The examples below use its public URL; browser requests require an origin allowed by the API's CORS configuration.

const response = await fetch("https://api.sherwood.stream/v1/public/events?type=curve.buy&limit=2");
if (!response.ok) throw new Error(await response.text());

const { data, nextCursor } = await response.json();
console.log(data, nextCursor);

const response = await fetch("https://api.sherwood.stream/v1/public/launches?limit=1");
if (!response.ok) throw new Error(await response.text());

const { streamCursor } = await response.json();
const url = new URL("https://api.sherwood.stream/v1/public/stream");

url.searchParams.set("type", "token.launched");
if (streamCursor) url.searchParams.set("after", streamCursor);

const source = new EventSource(url);
source.addEventListener("token.launched", (event) => {
  console.log(JSON.parse(event.data));
});

source.onerror = (error) => console.error("Stream disconnected", error);
// Call source.close() when this subscription is no longer needed.

EventSource reconnects automatically. The stream example starts after the newest launch so an old event backlog does not consume the connection's event quota. The streamCursor may be null when there are no launches yet.

Reference

All routes below use GET. Append each path to https://api.sherwood.stream. JSON routes return the listed fields. For parameter schemas and full response shapes, open interactive API docs or OpenAPI JSON.

/images/:cid expects the signed logoProxyUrl returned with a token; a bare CID URL is not a public unsigned image endpoint.

Filters and pagination

Search uses /tokens/search?q=...: query length 2–64, result limit 10 by default and 20 maximum. /analytics?period=day also accepts week, month and all; day is the default. Treat all cursors as opaque strings and URL-encode them when building a request.

Live stream

/stream sends confirmed canonical events as SSE. Use the same token and event-type filters as history. Each canonical message has event (its type), id (an opaque cursor) and JSON data. Start from an after cursor; on reconnect, Last-Event-ID takes precedence. Without a cursor, the stream replays available confirmed history from the beginning.

The stream also emits indexer.status, stats.updated and token.updated service messages. These are not canonical events. A : heartbeat comment arrives every 20 seconds. The stream accepts token(s), type(s) and after; it rejects status, limit and other query parameters.

Limits and errors

Invalid filters, limits or cursors return 400 with an error code such as invalid_cursor. A signed image request can return 403 for an invalid signature, 404 when the image is unavailable, or 502 when image gateways fail.

Coverage

PONS tokens can trade on curves or pools. The current indexer scans supported factory events and V2 bonding-curve events; it does not index pool swap logs. The event names returned by /v1/public/event-types describe the schema vocabulary, not a promise that every type is produced today. The staging and production configuration uses multistack coverage for the V1 factory and both supported V2 deployments. Backfill progress determines what history is available at a given moment.