TypeScript types

Active

Generated TS types — request params, response envelopes, every schema in the spec. Consumed automatically by @postio/core, @postio/node, @postio/react.

Install

npm i @postio/api-types

30-second example

import type { components } from '@postio/api-types';

type Address      = components['schemas']['Address'];
type EmailResult  = components['schemas']['EmailResult'];
type PhoneResult  = components['schemas']['PhoneResult'];

Other api tooling

OpenAPI specOpenAPI 3.1 document for the entire public API, byte-identical between postio.co.uk/openapi.json and the @postio/openapi npm package.
Postman collectionPostman v2.1 collection generated from the OpenAPI spec. Every endpoint with sample requests, ready to import.
Command-line interfacePostio from your terminal. Address, postcode, UDPRN, email, and phone validation via `npx postio …`. Pipe-friendly, jq-ready, scriptable.

TypeScript types

Install

30-second example

Links

Other api tooling