Skip to main content
GET
X job locations API: find places & location IDs
Find the places X job search knows by name. Pass a place name or its start, such as new york. Each match returns its name and the location ID that job search takes.
1 credit per place returned · All plans from $0.00012/credit

Search jobs in an exact place

A free-text location works for most searches. A location ID pins 1 exact place instead. New York City, NY and West New York, NJ then stay apart.
  1. Look up the place name here.
  2. Pick the matching place from locations.
  3. Send its id to job search as locationId.
Store the ID with the place name. The same ID works in later searches.

Control the cost

Each returned place costs 1 credit. A broad name such as york can match many places. Send limit to keep only the best matches. No match returns an empty list and costs nothing.

Query parameters

string
required
Place name or its start, such as new york. Alias: query.
integer
Most places to return. Without it, every match returns. Aliases: pageSize, count, max_results, maxItems, max_items & per_page.

Headers

string
Full account key. Sessions and OAuth also work.
string
Bearer xq_your_guest_key_here for paid_reads.

Response

200 OK

object[]
Matching places, best match first. Location object fields.
string
Location ID, which the job search locationId takes.
string
Place name with its region or country code.
number
Places returned, each charged 1 credit.

400 Missing query

Send a place name in q.

401 Unauthenticated

Anonymous requests get WWW-Authenticate: Bearer and a guest wallet checkout action. This is not a Payment challenge.

402 Payment required

Account keys get account options. Guest keys get guest top-up only. No checkout starts automatically. Confirm any payment action.

502 X API unavailable

The read service returned an error. Retry after a short delay.

429 Rate limit exceeded

You exceeded your tier rate limit. Wait for the Retry-After header before retrying.

424 Dependency failed

The normalized v1 response contract can return 424 when the read service is unavailable.
Next steps. Search job listings with the location ID, or get 1 job listing for its full description.