GWIX™GLOBAL WHOLESALE INTELLIGENCE EXCHANGE
API docs

Labor-market data from job ads, for people and AI agents

Ad volumes and advertised pay by occupation, company, industry and place, with market benchmarks, standardized IDs and occupation-code crosswalks. In regular releases, at metro, state and country level.

Try it now: the API Explorer runs every endpoint in your browser. Free sample data without sign-in; live data once you sign in.

Quickstart

  1. Get a key. Sign in at the console and create an API key. Buy credits there when you need more than the evaluation grant.
  2. Register your agent once (people calling the API directly can skip this). Your organization gets 5,000 evaluation credits ($250) once it saves a card in the console (nothing is charged; until card setup opens, when it accepts the Terms of Use), valid 12 months like purchased credits.
    curl -X POST https://api.gwix.ai/v1/agents \
      -H "Authorization: Bearer $GWIX_KEY" -H "Content-Type: application/json" \
      -d '{"name":"my-agent","operator_organisation":"Example Inc.","operator_domain":"example.com",
           "contact_email":"dev@example.com","intended_use":"comp_benchmarking","acts_for_end_users":false}'
    Send the returned agent_id as GWIX-Agent-Id on every call.
  3. Resolve names to IDs.
    curl "https://api.gwix.ai/v1/lookup/location?city=Denver&country=US" \
      -H "Authorization: Bearer $GWIX_KEY" -H "GWIX-Agent-Id: $GWIX_AGENT"
  4. Ask for statistics. Advertised pay for registered nurses (by SOC code) in Denver, last quarter, with the national benchmark:
    curl "https://api.gwix.ai/v1/pay?occupation_code=soc_2018:29-1141&location_id=mtr_denver_aurora_co&interval=quarter&benchmark=national" \
      -H "Authorization: Bearer $GWIX_KEY" -H "GWIX-Agent-Id: $GWIX_AGENT"
Before you report a result, read the operation's context file (/context/get_pay): what the numbers mean, minimum sample sizes, what zeros mean, and how to word results. Every response carries meta.citation; cite GWIX with it.

What you can ask

Statistics

Find IDs and codes

GET /v1/taxonomy/crosswalk

Map a code to other classifications

crosswalk
GET /v1/dimensions/{dimension}/{id}

Describe an ID

describe_dimension_value
GET /v1/dimensions

Dimension catalog

list_dimensions

Reference

GET /v1/periods

Which dates make up each period

list_periods
GET /v1/fx-rates

Exchange rates GWIX used

list_fx_rates
GET /v1/status

Data freshness by dataset

get_status

Your account

POST /v1/agents

Register an agent

register_agent
GET /v1/agents

Agents on this account

list_agents
GET /v1/account/usage

Balance, usage, caps and concurrency

get_usage

For agents

/llms.txt is the plain-text index; /openapi.json is the machine-readable API; /context/{operation} holds each operation's semantic context.