Codes - Suche nach Standortinformationen

Gast

Codes

Erhalten Sie alle Informationen, die Ihrer Anfrage entsprechen.

GET /v2/codes/search
Premium Professionell Unternehmen

Suche nach Standortinformationen

Ermöglicht die Suche nach Standortinformationen basierend auf einem Suchbegriff. Diese Funktion ist nützlich für Anwendungen, die Standortdetails anhand eines Suchbegriffs abrufen möchten.

GET https://zip-api.eu/api/v2/codes/search?query=...&search=...&match=...&fields=...&page[offset]=...&page[limit]=...
  • JavaScript
  • cURL
  • Python
  • PHP
  • Java
  • C#
const url = "https://zip-api.eu/api/v2/codes/search?query=Eugendorf&search=placeName";

fetch(url, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
curl -X GET "https://zip-api.eu/api/v2/codes/search?query=Eugendorf&search=placeName" \
     -H "Authorization: Bearer YOUR_API_KEY"
import requests

url = "https://zip-api.eu/api/v2/codes/search?query=Eugendorf&search=placeName"
headers = {
    "Authorization": "Bearer YOUR_API_KEY"
}

response = requests.get(url, headers=headers)

if response.status_code == 200:
    print(response.json())
else:
    print(f"Error: {response.status_code}")
$url = "https://zip-api.eu/api/v2/codes/search?query=Eugendorf&search=placeName";

// Initialize cURL session
$ch = curl_init();

// Set options
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_API_KEY'
]);

// Execute the request
$response = curl_exec($ch);

// Check for errors
if (curl_errno($ch)) {
    echo 'Error: ' . curl_error($ch);
} else {
    echo $response;
}

// Close the cURL session
curl_close($ch);
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;

public class ApiRequest {
    public static void main(String[] args) {
        try {
            String url = "https://zip-api.eu/api/v2/codes/search?query=Eugendorf&search=placeName";
            URL obj = new URL(url);
            HttpURLConnection con = (HttpURLConnection) obj.openConnection();

            // Request setup
            con.setRequestMethod("GET");
            con.setRequestProperty("Authorization", "Bearer YOUR_API_KEY");

            // Get response code
            int responseCode = con.getResponseCode();
            System.out.println("Response Code : " + responseCode);

            // Read the response
            BufferedReader in = new BufferedReader(new InputStreamReader(con.getInputStream()));
            String inputLine;
            StringBuffer response = new StringBuffer();

            while ((inputLine = in.readLine()) != null) {
                response.append(inputLine);
            }
            in.close();

            // Print the response
            System.out.println(response.toString());

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    private static readonly HttpClient client = new HttpClient();

    static async Task Main(string[] args)
    {
        string url = "https://zip-api.eu/api/v2/codes/search?query=Eugendorf&search=placeName";

        // Add authorization header
        client.DefaultRequestHeaders.Add("Authorization", "Bearer YOUR_API_KEY");

        // Send GET request
        HttpResponseMessage response = await client.GetAsync(url);

        // Check the status code and get the response content
        if (response.IsSuccessStatusCode) {
            string responseBody = await response.Content.ReadAsStringAsync();
            Console.WriteLine(responseBody);
        } else {
            Console.WriteLine("Error: " + response.StatusCode);
        }
    }
}

Header

API-Schlüssel string - erforderlich
Bearer-Token zur Authentifizierung.

Abfrageparameter

GET query string - erforderlich

Der Suchbegriff oder die Zeichenkette, nach der gesucht werden soll.

GET search string - optional

Die Parameter durch Kommas getrennt, nach denen gesucht werden soll.
Verfügbare Parameter: postalCode, placeName, state;

GET match string - optional (Standardwert: autocomplete)

Gibt das Suchverhalten für die Übereinstimmung mit dem Begriff in den Feldern an.
Verfügbare Typen:

  • all: Entspricht einem beliebigen Teil des Felds.
  • exact: Entspricht genau dem Feld.
  • autocomplete: Präfixbasierte Übereinstimmung für die Autovervollständigung.
  • leading: Entspricht dem Feldanfang.
  • trailing: Entspricht dem Feldende.
GET fields string - optional

Die Parameter durch Kommas getrennt, nach denen gefiltert werden soll.

GET page[offset] string - optional

Dieser Parameter bestimmt den Startpunkt und die Anzahl der Datensätze, die auf jeder Seite enthalten sein sollen. Verbessert die Suchgeschwindigkeit.

GET page[limit] string - optional

Dieser Parameter bestimmt den Startpunkt und die Anzahl der Datensätze, die auf jeder Seite enthalten sein sollen. Verbessert die Suchgeschwindigkeit.

Antwortparameter

countryCode string

Zweibuchstabiger Ländercode (Alpha-2-Code), definiert in ISO 3166-1.

postalCode string

Die Postleitzahl des Ortes oder der Region.

state string

Der geografische Bundesland- oder Provinzname.

placeName string

Der Name des Ortes oder der Stadt.

latitude float

Der Breitengrad der geografischen Position, gemessen in Dezimalgraden.

longitude float

Der Längengrad der geografischen Position, gemessen in Dezimalgraden.

Statuscodes

200 Standardantwort für erfolgreich bearbeitete Anfragen
400 Ungültige Anforderung
401 Nicht autorisiert
403 Verboten
404 Nicht gefunden
405 Methode nicht erlaubt
409 Konflikt
413 Anforderungselement zu groß
429 Zu viele Anfragen
500 Interner Serverfehler