@ideal-postcodes/sdk
v0.1.0
Published
Fetch-based, treeshakable TypeScript SDK for api.ideal-postcodes.co.uk
Readme
@ideal-postcodes/sdk
Fetch-based, treeshakable TypeScript SDK for api.ideal-postcodes.co.uk.
Install
npm install @ideal-postcodes/sdkQuick start
import { createIdpcClient, postcodes } from "@ideal-postcodes/sdk";
const client = createIdpcClient({ apiKey: "ak_..." });
const { data } = await postcodes({ client, path: { postcode: "SW1A2AA" } });
console.log(data?.result);Documentation
Full documentation lives at docs.ideal-postcodes.co.uk/docs/sdks/typescript — concepts, autocomplete utilities, TanStack Query bindings, and a per-operation API reference.
Licence
See LICENSE.
