OpenAPI spec

Active

OpenAPI 3.1 document for the entire public API, byte-identical between postio.co.uk/openapi.json and the @postio/openapi npm package.

Install

Direct URL

https://postio.co.uk/openapi.json

npm

npm i @postio/openapi

30-second example

# Codegen with openapi-typescript
npx openapi-typescript ./node_modules/@postio/openapi/openapi.json \
    -o src/postio-types.ts

# …or paste the URL into Postman, Insomnia, Bruno, Stoplight,
# Scalar, Redoc, etc. — any OpenAPI 3.1 consumer.

Other api tooling

TypeScript typesGenerated TS types — request params, response envelopes, every schema in the spec. Consumed automatically by @postio/core, @postio/node, @postio/react.
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.

OpenAPI spec

Install

30-second example

Links

Other api tooling