Erste Schritte

Erstellen Sie Ihr Konto, hinterlegen Sie eine Zahlungsmethode, rufen Sie Ihren API-Schlüssel ab und führen Sie Ihren ersten Aufruf der Listings API aus.

Diese Anleitung erklärt, wie Sie ein Konto erstellen, Ihren ersten API-Schlüssel abrufen und eine Anfrage an die Listings API senden.

Sandbox-Tagespass

Wenn ein Sandbox-Tagespass angeboten wird, können Sie sich mit Ihrem Namen, Ihrer E-Mail-Adresse und Ihrem Unternehmen ohne Karte oder Passwort registrieren und dieselbe API und denselben MCP-Server 24 Stunden lang nutzen. Wir senden Ihnen per E-Mail einen Link und einen 6-stelligen Code. Ihr Konto wird erst erstellt und Ihre 24 Stunden beginnen erst, wenn Sie den Link öffnen und auf Start my day pass (Meinen Tagespass starten) klicken oder wenn der Code verwendet wird, sodass ein KI-Agent den Pass mit dem Code für Sie starten kann. Ein Sandbox-Konto umfasst bis zu zwei Standorte, bietet Zugriff auf die Endpunkte für Standorte und Einträge und synchronisiert seine Einträge ausschließlich mit listingsAPI-Demo-Verzeichnissen, niemals mit echten Plattformen. Nach Ablauf der 24 Stunden funktionieren die API-Schlüssel des Kontos nicht mehr, und Sie haben 48 Stunden Zeit, sich mit derselben E-Mail-Adresse für Launch oder Growth anzumelden, bevor das Sandbox-Konto und seine Daten gelöscht werden. Der Tagespass hat kein Passwort; wählen Sie daher auf der Anmeldeseite Email me a sign-in link (Anmeldelink per E-Mail senden), um sich erneut anzumelden. Die Anleitung zum Tagespass enthält alle Details, einschließlich der Aufrufe, die ein Agent ausführt.

1. Erstellen Sie Ihr Konto

Wählen Sie auf der Preisseite einen Tarif aus, um das Registrierungsformular zu öffnen, und geben Sie dann Ihren first name (Vornamen), last name (Nachnamen), Ihre work email (geschäftliche E-Mail-Adresse) und Ihr company (Unternehmen) an. Haben Sie bereits ein Konto? Melden Sie sich stattdessen an.

2. Hinterlegen Sie eine Zahlungsmethode

Nachdem Sie das Formular abgeschickt haben, leiten wir Sie zu unserem Zahlungsanbieter weiter, damit Sie eine Karte hinterlegen können. Ihre kostenlose Testphase beginnt sofort und geht nach Ablauf in den von Ihnen gewählten Tarif über; kündigen Sie daher vor Ablauf, wenn Ihnen keine Kosten entstehen sollen. Die FAQ zu Preisen enthalten die aktuelle Dauer der Testphase und die Tariflimits.

Sobald der Bestellvorgang abgeschlossen ist, senden wir Ihnen per E-Mail einen Link, über den Sie Ihr Passwort festlegen und Ihr Konto aktivieren können. Nachdem Sie Ihr Passwort festgelegt haben, melden Sie sich mit Ihrer E-Mail-Adresse und Ihrem Passwort an oder wählen Sie Email me a sign-in link (Anmeldelink per E-Mail senden), um stattdessen einen einmalig verwendbaren Anmeldelink zu erhalten.

4. Rufen Sie Ihren API-Schlüssel ab

Ihr erster API-Schlüssel wird bei der Erstellung Ihres Kontos automatisch ausgestellt; Sie finden ihn im Dashboard unter API Keys. Um einen weiteren zu erstellen, wählen Sie New key (Neuer Schlüssel), geben Sie ihm einen Namen und wählen Sie seine Zugriffsstufe (Read (Lesen) oder Write (Schreiben)).

5. Senden Sie Ihre erste Anfrage

Authentifizieren Sie jede Anfrage mit einem Authorization-Header, dessen Wert aus der wörtlichen Zeichenfolge API (beachten Sie das abschließende Leerzeichen), gefolgt von Ihrem Schlüssel, besteht:

Shell

curl https://listingsapi.com/api/v4/locations \  -H "Authorization: API $LISTINGSAPI_KEY"

Die Antwort ist verschachtelt und kein einfaches Array: Die Ergebnisse befinden sich unter data.allLocations, jeder Datensatz ist ein edges[].node, und pageInfo enthält den Paginierungscursor und die Gesamtzahlen.

JSON

{  "data": {    "allLocations": {      "edges": [        {          "cursor": "TG9jYXRpb246MTgwMDI4OQ==",          "node": {            "id": "TG9jYXRpb246MTgwMDI4OQ==",            "databaseId": 1800289,            "name": "Jenny Home",            "city": "Austin",            "stateIso": "TX",            "countryIso": "US"          }        }      ],      "pageInfo": {        "endCursor": "TG9jYXRpb246MTgwMDI4OQ==",        "hasNextPage": false,        "total": 1      }    }  }}

Um zur nächsten Seite zu wechseln, übergeben Sie pageInfo.endCursor wieder als ?after=…, solange pageInfo.hasNextPage den Wert true hat, und beenden Sie die Paginierung auch dann, wenn eine Seite mit einem leeren edges-Array zurückgegeben wird. Jede Edge enthält außerdem ihren eigenen cursor, und der cursor der letzten Edge ist der endCursor dieser Seite, sodass beide Werte als ?after= verwendet werden können.

Nicht jeder Listenendpunkt verwendet dieselbe Paginierung

Die oben gezeigte Struktur mit edges / node / pageInfo entspricht dem Relay-Cursor-Stil und ist nur eine von drei Varianten:

Cursor-Paginierung (first, after → edges[].node sowie pageInfo mit endCursor / hasNextPage): Standorte, Standortsuche und die Endpunkte für Bewertungen (Interaktionen pro Standort und die Aggregation auf Kontoebene).
Offset-Paginierung (page, perPage → ein records-Array sowie pageInfo mit totalRecords, totalPages, hasNextPage, hasPreviousPage): verbundene Konten, Verbindungsvorschläge, Beiträge für einen Standort, Massenbeiträge für einen Standort und die kontoweite Aggregation doppelter Einträge.
Einfache Arrays, ganz ohne Paginierung: die Katalogendpunkte (Unterkategorien, Länder und Bundesstaaten, im Tarif enthaltene Plattformen) und die Fotos eines Standorts.

Prüfen Sie das Antwortbeispiel auf der jeweiligen Endpunktseite, bevor Sie eine Paginierungsschleife schreiben; eine Cursor-Schleife für einen Offset-Endpunkt liest einen Schlüssel edges, der dort nie vorhanden ist.

Nächste Schritte

Sandbox-Tagespass: Probieren Sie Standorte und Einträge aus, ohne eine Kreditkarte angeben zu müssen. Sie oder Ihr KI-Agent können den Tagespass starten.
Authentifizierung: Header für API-Schlüssel und Schlüsselrotation.
Fehlercodes: HTTP-Statuscodes und die Struktur der Fehlerantwort.
SDKs: typisierte Python- und Node-Clients.