Geoapify plugin

• Two API versions live on one host. Geocoding, routing, isolines, the route matrix, postcodes, boundaries, elevation, IP geolocation and timezones are /v1; places, place details and place info are /v2. The plugin picks the right one per operation, so a caller never has to think about it.
• Geoapify answers GeoJSON by default. Every response would be a feature collection with the geometry inline, which is awkward to read when all you want is an address. The plugin asks for format: json on geocoding, autocomplete and postcodes, so results is a plain array. Routing also takes format: 'geojson'; in json it already returns the route line as points per leg.
• places has no format parameter at all. It always answers a feature collection, so its results sit under features with the place under properties.
• A pair with no route is not a failure. In routing.matrix, an unreachable source-to-target pair has null distance and time, and the rest of the matrix is still valid. Points are { lat, lon } objects.
• A slow isoline comes back later. routing.isoline can answer with no areas and only properties.id; call it again with that id alone to read the result. Ranges are at most 3600 seconds or 100000 metres.
• The EU host exists. region: 'eu' sends the request to api-eu.geoapify.com, where processing stays in the European Union. It takes the same operations and the same key.
• limit has a per-API maximum. It is 100 on the geocoding routes and 500 on places, and the plugin rejects a larger value before the request rather than letting the gateway answer 400.
• A 429 is not always a burst. It covers an exhausted quota too. The plugin does not retry Quota exceeded, which only fails again until the credits reset; a burst is retried with backoff and honours Retry-After.
• Geocoding is a read. Every operation here computes an answer and changes nothing on Geoapify’s side, so all of them are read. Each request still uses credits. Baseline costs are 1 for a geocode, 1 per waypoint pair for a route, and max(sources, targets) × min(sources, targets, 10) for a matrix. Route details such as elevation, avoidances and long distances add more.

• 14 typed API operations

Setup

npm install corsair @corsair-dev/geoapify better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/geoapify better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/geoapify better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/geoapify better-sqlite3
bun add --dev @types/better-sqlite3

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { geoapify } from '@corsair-dev/geoapify';

export const corsair = createCorsair({
	plugins: [
		geoapify(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});

geoapify()

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'geoapify',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.geoapify.api.geocode.forward({
	text: 'Berlin',
	countrycodes: ['de'],
	limit: 3,
});

What’s next