Getting started

Create your account, add payment, get your API key, and make your first Listings API call.

This guide explains how to create an account, getting your first API key, and making a request against the Listings API.

Sandbox day pass

When a sandbox day pass is offered, you can sign up with your name, email, and company, without a card or a password, and use the same API and MCP server for 24 hours. We email you a link and a 6-digit code. Your account is created and your 24 hours start only when you open the link and press Start my day pass, or when the code is used, so an AI agent can start the pass for you with the code. A sandbox account holds up to two locations, covers the locations and listings endpoints, and syncs its listings only to listingsAPI demo directories, never to real publishers. When the 24 hours are up, its API keys stop working, and you have 48 hours to sign up for Launch or Growth with the same email before the sandbox account and its data are deleted. The day pass has no password, so to sign back in, choose Email me a sign-in link on the sign-in page. The day pass guide has the full details, including the calls an agent makes.

1. Create your account

Pick a plan on the pricing page to open the sign-up form, then enter your first name, last name, work email, and company. Already have an account? Sign in instead.

2. Add payment

After you submit the form we send you to our payment provider to add a card. Your free trial starts right away and converts to the plan you picked when the trial ends, so cancel before then if you don't want to be charged. The pricing FAQ has the current trial length and plan limits.

Once checkout is complete we email you a link to set your password and activate your account. After your password is set, sign in with your email and password, or choose Email me a sign-in link to receive a one-time magic link instead.

4. Get your API key

Your first API key is issued automatically when your account is created, find it in the dashboard under API Keys. To create another, choose New key, give it a name, and pick its access level (Read or Write).

5. Make your first request

Authenticate every request with an Authorization header whose value is the literal string API (note the trailing space), followed by your key:

Shell

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

The response is nested rather than a bare array: results are under data.allLocations, each record is an edges[].node, and pageInfo carries the pagination cursor and totals.

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      }    }  }}

To page forward, pass pageInfo.endCursor back as ?after=… while pageInfo.hasNextPage is true, and stop as well if a page comes back with an empty edges array. Each edge also carries its own cursor, and the last edge's cursor is that page's endCursor, so either value works as ?after=.

Not every list endpoint pages the same way

The edges / node / pageInfo shape above is the Relay-cursor style, and it is only one of three:

Cursor pages (first, after → edges[].node plus pageInfo with endCursor / hasNextPage): locations, location search, and the review endpoints (per-location interactions and the account rollup).
Offset pages (page, perPage → a records array plus pageInfo with totalRecords, totalPages, hasNextPage, hasPreviousPage): connected accounts, connection suggestions, posts for a location, bulk posts for a location, and the account-wide duplicate-listings rollup.
Plain arrays, with no pagination at all: the catalog endpoints (subcategories, countries and states, plan sites) and a location's photos.

Check the response example on an endpoint's own page before writing a paging loop; a cursor loop against an offset endpoint reads an edges key that is never there.

Next steps

Sandbox day pass: try locations and listings with no card required. You or your AI agent can start it.
Authentication: API key headers and key rotation.
Error codes: HTTP status codes and the error response shape.
SDKs: typed Python and Node clients.