Command-line interface

30-second example

export POSTIO_API_KEY=pk_…

postio connect                              # smoke-test the key
postio address postcode SW1A1AA             # human-readable table
postio address search "10 downing"          # autocomplete suggestions
postio email someone@example.com            # deliverability + signals
postio phone +447700900123                  # validity + carrier + type

# Stream from stdin:
cat postcodes.txt | postio address postcode -

# Pipe to jq:
postio address udprn 23747212 --json | jq '.results[0].postcode'

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.
• 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.