Polygon.io plugin

• Plans gate the data, not the routes. A free (Basic) key reaches market status and holidays, tickers, ticker types, exchanges and the end-of-day aggregates (bars by minute and up, previousDay, dailySummary, marketSummary). Snapshots, movers and second bars need a paid plan. When a plan does not include a dataset the API answers 403 NOT_AUTHORIZED rather than an empty result, and the plugin reports that as a permission error instead of retrying.
• status is not always OK. A plan with delayed data answers DELAYED, so the field stays a string rather than an enum a future value could break.
• Paging. aggregates.bars and tickers.list return next_url while another page exists (marketSummary answers every ticker in one page). It already carries the cursor and your filters, so pass it to the same operation as nextUrl and the other arguments are ignored. Any apiKey the URL echoes is dropped, because the plugin adds the caller’s own.
• A missing bar is not an error. aggregates.bars omits results when no qualifying trades happened in the window, so the plugin reads that as an empty page rather than a failed call. It does not mean the market was closed: an open session with no trades produces the same answer. Use market.status when you need the current market state.
• Rates. The free tier allows 5 calls a minute. A 429 is retried by the transport three times, honouring any Retry-After the API sends; the plugin adds no retries of its own, so the budget is not multiplied.
• Webhooks. The API sends none, so the plugin receives none.

• 12 typed API operations

Setup

npm install corsair @corsair-dev/polygonio better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/polygonio better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/polygonio better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/polygonio better-sqlite3
bun add --dev @types/better-sqlite3

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { polygonio } from '@corsair-dev/polygonio';

export const corsair = createCorsair({
	plugins: [
		polygonio(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});

polygonio()

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'polygonio',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.polygonio.api.tickers.list({ market: 'stocks', active: true });

const tenant = corsair.withTenant('acme');
await tenant.polygonio.api.snapshots.snapshot({ ticker: 'AAPL' });

What’s next