Skip to content

placekit/api-reference

Repository files navigation

PlaceKit API Reference

Location data, search and autocomplete for your apps

License: CC BY-SA 4.0


PlaceKit REST API Reference helps you use our services with any language. It's available at api.placekit.io, and you can also download our OpenAPI specification.

For front-end use cases, we highly recommend using our JavaScript libraries instead of accessing our API directly. Find out about all available SDKs and libraries in our GitHub organisation or our developers section on our website.

🏗️ Maintain specifications

We use the open source Redocly CLI to generate our documentation website based on OpenAPI Specifications version 3.1.0.

npm install # install Redocly CLI tool
npm start   # preview changes at http://localhost:8080/
npm lint    # according to OpenAPI specifications 3.1.0
npm build   # generates HTML documentation in `dist/index.html`

🚚 Deployment

Deployment of a new version is handled by a Github Action publishing the generated HTML on Github Pages.

⚖️ License

This repository is licensed under the CC-BY-SA-4.0 license. The API usage depends on our Terms and Conditions.