{"id":14483467,"url":"https://github.com/pirxpilot/postal-api","last_synced_at":"2025-07-24T20:32:04.774Z","repository":{"id":57327699,"uuid":"199094257","full_name":"pirxpilot/postal-api","owner":"pirxpilot","description":"REST API server for libpostal","archived":false,"fork":false,"pushed_at":"2024-03-05T06:56:59.000Z","size":15,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-11-23T19:13:20.396Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pirxpilot.png","metadata":{"files":{"readme":"Readme.md","changelog":"History.md","contributing":null,"funding":null,"license":null,"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":"2019-07-27T00:02:25.000Z","updated_at":"2022-05-20T16:46:48.000Z","dependencies_parsed_at":"2024-10-23T08:24:42.438Z","dependency_job_id":"f9c33de4-c799-4cba-bf4c-8c344f2ce37b","html_url":"https://github.com/pirxpilot/postal-api","commit_stats":{"total_commits":15,"total_committers":2,"mean_commits":7.5,"dds":0.06666666666666665,"last_synced_commit":"804f961a755194db1cb574383492866ce87ecd16"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pirxpilot%2Fpostal-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pirxpilot%2Fpostal-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pirxpilot%2Fpostal-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pirxpilot%2Fpostal-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pirxpilot","download_url":"https://codeload.github.com/pirxpilot/postal-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227476143,"owners_count":17779417,"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-09-03T00:01:47.617Z","updated_at":"2024-12-01T03:08:37.783Z","avatar_url":"https://github.com/pirxpilot.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"[![NPM version][npm-image]][npm-url]\n[![Build Status][build-image]][build-url]\n\n# postal-api\n\nREST API server for libpostal\n\n## Install\n\n```sh\n$ npm install --global postal-api\n```\n\nPlease note that postal-api is using [postal-async] and it expects that\nlibpostal data is located in `/var/lib/libpostal`.\n\nSee [libpostal docs] on how to download the data.\n\n## API\n\n### `parse`\n\n```sh\n curl 'http://localhost:4030/parse?address=781+Franklin+Ave+Crown+Hts+Brooklyn+NY'\n```\n\n```json\n[\n  {\n    \"label\": \"house_number\",\n    \"value\": \"781\"\n  },\n  {\n    \"label\": \"road\",\n    \"value\": \"franklin ave\"\n  },\n  {\n    \"label\": \"suburb\",\n    \"value\": \"crown hts\"\n  },\n  {\n    \"label\": \"city_district\",\n    \"value\": \"brooklyn\"\n  },\n  {\n    \"label\": \"state\",\n    \"value\": \"ny\"\n  }\n]\n\n```\n\n\n### `expand`\n\n```sh\ncurl 'http://localhost:4030/expand?address=781+Franklin+Ave+Crown+Hts+Brooklyn+NY'\n```\n\n\n```json\n[\n  \"781 franklin avenue crown heights brooklyn ny\",\n  \"781 franklin avenue crown heights brooklyn new york\"\n]\n```\n\n## Environment\n\n`postal-api` is using [dotenv] and by default reads its environment from `/etc/default/postal-api`\n\n- `POSTAL_API_PORT` - port number on which postal-api listens, defaults to 4030\n\n\n## License\n\nMIT © [Damian Krzeminski](https://pirxpilot.me)\n\n[dotenv]: https://www.npmjs.com/package/dotenv\n[postal-async]: https://www.npmjs.com/package/postal-async\n[libpostal docs]: https://github.com/openvenues/libpostal#data-files\n\n[npm-image]: https://img.shields.io/npm/v/postal-api\n[npm-url]: https://npmjs.org/package/postal-api\n\n[build-url]: https://github.com/pirxpilot/postal-api/actions/workflows/check.yaml\n[build-image]: https://img.shields.io/github/actions/workflow/status/pirxpilot/postal-api/check.yaml?branch=main\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpirxpilot%2Fpostal-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpirxpilot%2Fpostal-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpirxpilot%2Fpostal-api/lists"}