docs / getting started / quickstart
Quickstart
Make your first request in about two minutes. You need an API key, which you can create for free on the pricing page. Test keys start with ls_test_ and never count toward your bill.
curl https://api.lodestar.example/v1/geocode \
-H "Authorization: Bearer ls_test_..." \
-d q="rathausplatz 1 wien"Authentication
Send your key in the Authorization header as a bearer token. Keys are scoped to a project, and you can create read only keys for browser use with an allowed domain list.
Keep live keys on your server. For search boxes in the browser, use a public key with allowed_origins set.
Geocode an address
GET/v1/geocode
Returns the best match for a free form address or place name, with coordinates, a formatted address and a confidence score between 0 and 1.
| Parameter | Description |
|---|---|
qrequiredstring | The address or place to look up. Typos and missing postcodes are fine. |
countrystring | Two letter country code to narrow results, for example AT. |
nearlat,lng | Bias results toward a point, useful for local search. |
langstring | Language for the formatted address. Defaults to the local language. |
Validate for delivery
POST/v1/validate
Checks an address against postal data and tells you whether a parcel can be delivered there, with a standardized version you can store.
Search places
GET/v1/places
Autocomplete for search inputs. Returns up to 10 suggestions ranked by text match and distance, fast enough to call on every keystroke.
SDKs
Official libraries for JavaScript, Python, Go and Ruby. Each one handles retries, pagination and typed responses.
Errors
Errors return a JSON body with a code and a readable message. A 422 means the address could not be matched; the body includes suggestions when there are any.
Rate limits
Free keys allow 10 requests per second. Paid plans start at 100 per second and can go higher on request. Every response includes x-ratelimit-remaining.