How to Import Geoapify OpenAPI into an API Client

Import a Geoapify specification into an API client

You want to explore a Geoapify API in an OpenAPI-compatible client without recreating its endpoints, parameters, and schemas manually. Start with one focused specification from the Geoapify OpenAPI catalog, import it, and send a known request.

This guide uses the Forward Geocoding API specification and the address Alexanderplatz, Berlin, Germany. The desired result is a client collection that exposes the documented geocoding operation and returns coordinates for that address.

Task flow: focused OpenAPI URL → API client import → secret API-key variable → verified geocoding response.

Examples of OpenAPI-compatible API clients:

The steps in this guide apply to all three clients. Their screen labels differ, but each can turn the focused Geoapify specification into executable requests.

Importing a specification creates a useful starting collection, but it does not make credentials safe automatically. Keep the API key in the client's environment or secret storage and never export it with a shared collection.

Import the specification and configure authorization

Step 1: Copy the focused OpenAPI URL

Use this canonical Forward Geocoding specification URL:

https://apidocs.geoapify.com/assets/openapi/specs/forward-geocoding/forward-geocoding-api-openapi-specs.json

Step 2: Import the specification

In your chosen OpenAPI-compatible client, create a new API, workspace, or collection by importing from a URL. Paste the specification URL and select OpenAPI when the client asks for a format.

The exact menu names differ between clients, but the imported contract should contain the operation path, parameter definitions, response schemas, and examples. If a client creates example requests without inheriting security, add the environment variable to those requests rather than pasting the key as plain text.

Step 3: Select the API server

Confirm that the imported server is https://api.geoapify.com.

Use the EU server shown in the specification only when requests must be processed exclusively within the European Union. Keep the server consistent across the collection so test results do not unexpectedly switch regions.

Step 4: Get a Geoapify API key

Create a project and copy an API key from Geoapify MyProjects. An API key is required for direct Geoapify API requests. If you only want to explore requests without configuring a key, use the Geocoding Playground.

Step 5: Store the API key as a secret

Create a private client environment variable such as GEOAPIFY_API_KEY. Map that secret to the imported apiKey security parameter or query parameter.

Do not paste the key into the specification, request name, example, or shared collection. Apply origin, referrer, or IP restrictions in MyProjects when they are appropriate for the application.

Step 6: Save the collection safely

Save the imported collection and its non-sensitive settings. Before exporting or sharing it, confirm that the environment, resolved API key, request history, and credential-bearing URLs are excluded.

Verify the imported request

Open the imported forward-geocoding operation and set the free-text address input to:

Alexanderplatz, Berlin, Germany

Set limit=1, ensure the API-key field resolves from the private environment, and send the request. A successful response has HTTP status 200 and a GeoJSON FeatureCollection containing at least one feature. The selected result should describe Alexanderplatz in Berlin and include numeric lat and lon properties.

Check these points before saving the collection:

• The request uses a server declared by the specification.
• The API key is resolved at runtime and is absent from request names, examples, logs, and exported files.
• Free-text and structured address parameters are not combined in one request; they are alternative input styles.
• GeoJSON geometry coordinates use [longitude, latitude] order.
• 401 indicates missing or invalid authorization, while a 400 response generally means the request does not satisfy the documented parameter contract.

If an imported request differs from the Forward Geocoding documentation, reimport the canonical specification before editing generated operations manually.