{"id":18369186,"url":"https://github.com/ideal-postcodes/core-axios","last_synced_at":"2025-04-06T17:31:59.209Z","repository":{"id":37866694,"uuid":"235588155","full_name":"ideal-postcodes/core-axios","owner":"ideal-postcodes","description":"Axios backed Ideal Postcodes Javascript Client","archived":false,"fork":false,"pushed_at":"2025-03-24T17:49:20.000Z","size":1528,"stargazers_count":0,"open_issues_count":10,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-02T23:35:19.323Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ideal-postcodes.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-22T14:14:44.000Z","updated_at":"2025-03-24T15:22:31.000Z","dependencies_parsed_at":"2023-11-27T10:38:30.728Z","dependency_job_id":"d076cb90-64ca-49ef-b597-056135eb8448","html_url":"https://github.com/ideal-postcodes/core-axios","commit_stats":{"total_commits":419,"total_committers":7,"mean_commits":"59.857142857142854","dds":0.4009546539379475,"last_synced_commit":"7a30799e186f1a0ed0accdf386b75bae8f122ac5"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideal-postcodes%2Fcore-axios","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideal-postcodes%2Fcore-axios/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideal-postcodes%2Fcore-axios/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ideal-postcodes%2Fcore-axios/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ideal-postcodes","download_url":"https://codeload.github.com/ideal-postcodes/core-axios/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247522460,"owners_count":20952555,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T23:28:41.130Z","updated_at":"2025-04-06T17:31:58.779Z","avatar_url":"https://github.com/ideal-postcodes.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003cimg src=\"https://img.ideal-postcodes.co.uk/Ideal%20Postcodes%20Axios%20Logo@3x.png\" alt=\"Ideal Postcodes Axios\"\u003e\n\u003c/h1\u003e\n\n\u003e Axios backed JavaScript client for api.ideal-postcodes.co.uk\n\n![CI](https://github.com/ideal-postcodes/core-axios/workflows/CI/badge.svg)\n[![codecov](https://codecov.io/gh/ideal-postcodes/core-axios/branch/master/graph/badge.svg)](https://codecov.io/gh/ideal-postcodes/core-axios)\n[![Dependency Status](https://david-dm.org/ideal-postcodes/core-axios.svg)](https://david-dm.org/ideal-postcodes/core-axios)\n[![npm version](https://badge.fury.io/js/%40ideal-postcodes%2Fcore-axios.svg)](https://www.npmjs.com/package/@ideal-postcodes/core-axios)\n[![install size](https://packagephobia.now.sh/badge?p=@ideal-postcodes/core-axios)](https://packagephobia.now.sh/result?p=@ideal-postcodes/core-axios)\n[![Release](https://github.com/ideal-postcodes/core-axios/workflows/Release/badge.svg)](https://github.com/ideal-postcodes/core-axios/actions)\n\n`@ideal-postcodes/core-axios` is the Axios backed client for api.ideal-postcodes.co.uk. Axios is a promise based HTTP client for the browser and node.js and so is ideal for:\n\n- Frameworks that utilise server side rendering (Angular, Next.js, React, etc)\n- Isomorphic code (runs on browser and server)\n\nOur JavaScript client implements a common interface defined at [@ideal-postcodes/core-interface](https://github.com/ideal-postcodes/core-interface).\n\nHigh level client documentation can be found at [core-interface](https://github.com/ideal-postcodes/core-interface/blob/master/README.md).\n\nIn depth client documentation can be found at [core-interface.ideal-postcodes.dev](https://core-interface.ideal-postcodes.dev).\n\n## Links\n\n- [Configuration \u0026 Usage](#configuration--usage)\n- [Quickstart](#quickstart)\n- [Client Documentation](https://github.com/ideal-postcodes/core-interface/blob/master/README.md)\n- [In Depth Client Documentation](https://core-interface.ideal-postcodes.dev/#documentation)\n- [npm Module](https://www.npmjs.com/package/@ideal-postcodes/core-axios)\n- [GitHub Repository](https://github.com/ideal-postcodes/core-axios)\n\n## Other JavaScript Clients\n\n- [Node.js Client Repository](https://github.com/ideal-postcodes/core-node)\n- [Browser Client Repository](https://github.com/ideal-postcodes/core-browser)\n- [Bundled Browser Client Repository](https://github.com/ideal-postcodes/core-browser-bundled)\n\n## Documentation\n\n### Configuration \u0026 Usage\n\n- [Install](#install)\n- [Instantiate](#instantiate) and [Use](#use) client\n- [Catch Errors](#catch-errors)\n\n#### Install\n\n```bash\nnpm install @ideal-postcodes/core-axios\n```\n\n#### Instantiate\n\n```javascript\nimport { Client } from \"@ideal-postcodes/core-axios\"\n\nconst client = new Client({ api_key: \"iddqd\" });\n```\n\n[Configuration options](https://core-interface.ideal-postcodes.dev/interfaces/Client.Config.html#baseUrl)\n\n\n#### Use\n\n```javascript\nimport { lookupPostcode } from \"@ideal-postcodes/core-axios\"\n\nconst addresses = await lookupPostcode({ client, postcode: \"SW1A2AA\" });\n```\n\n#### Catch Errors\n\n```javascript\nimport { errors, lookupAddress } from \"@ideal-postcodes/core-axios\"\n\ntry {\n  await lookupAddress({ client, query: \"10 downing street\" });\n} catch (error) {\n  if (error instanceof errors.IdpcRequestFailedError) {\n    // IdpcRequestFailedError indicates a 402 response code\n    // Possibly the key balance has been depleted\n  }\n}\n```\n\n## Test\n\n```bash\nnpm test\n```\n\n## Licence\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fideal-postcodes%2Fcore-axios","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fideal-postcodes%2Fcore-axios","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fideal-postcodes%2Fcore-axios/lists"}