{ "openapi": "3.0.1", "info": { "title": "Job Market Data API - Job Postings, Wages and Labor Market Data", "description": "Search real-time job postings and labor market data by region, occupation, industry and skill, and export structured records with wages, job titles, employers and SOC codes. Pay per result. Bring your own API key.", "version": "0.1", "x-build-id": "jGg7XjruQTpK0Q810" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~job-market-data-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-job-market-data-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/nabeelbaghoor~job-market-data-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-job-market-data-api", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/nabeelbaghoor~job-market-data-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-job-market-data-api", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "freetext": { "title": "Keyword search", "type": "string", "description": "Free-text search across job postings, e.g. `registered nurse` or `python developer`. Combined with the filters below." }, "title": { "title": "Job title contains", "type": "string", "description": "Keep only postings whose title contains this text, e.g. `data engineer`." }, "occupation": { "title": "Occupation contains", "type": "string", "description": "Filter by occupation name (SOC), e.g. `software developers`." }, "industry": { "title": "Industry contains", "type": "string", "description": "Filter by industry name (NAICS), e.g. `hospitals`." }, "skill": { "title": "Skill contains", "type": "string", "description": "Filter by a required skill, e.g. `sql` or `aws`." }, "regionType": { "title": "Region type", "enum": [ "State", "MSA", "County", "Country", "Total", "LocString" ], "type": "string", "description": "Geography level for the region code below. Use the reference lookups in the provider docs to find codes.", "default": "State" }, "regionCode": { "title": "Region code", "type": "integer", "description": "Numeric region code for the selected region type, e.g. State 39 = Ohio, MSA 1698 = Chicago. Leave empty to search all regions (subject to your license coverage)." }, "regions": { "title": "Regions (advanced)", "type": "array", "description": "Power users: an array of region objects `[{ \"type\": \"State\", \"code\": 39 }, { \"type\": \"MSA\", \"code\": 1698 }]`. When set, this replaces the single region type/code above." }, "startDate": { "title": "Posted from", "type": "string", "description": "Only postings first seen on or after this date (YYYY-MM-DD)." }, "endDate": { "title": "Posted to", "type": "string", "description": "Only postings first seen on or before this date (YYYY-MM-DD)." }, "postState": { "title": "Posting status", "enum": [ "Active", "New", "Closed", "CurrentActive", "NewlyDownloaded" ], "type": "string", "description": "Which postings to include by lifecycle state.", "default": "Active" }, "adType": { "title": "Ad type", "enum": [ "All", "NonStaffing", "Staffing" ], "type": "string", "description": "Include all postings, or restrict to staffing-agency or non-staffing postings.", "default": "All" }, "dataset": { "title": "Dataset", "enum": [ "US", "Global" ], "type": "string", "description": "US or Global job posting dataset (subject to your license).", "default": "US" }, "excludeStaffing": { "title": "Exclude staffing agencies", "type": "boolean", "description": "Drop postings from staffing agencies.", "default": false }, "useImputedWages": { "title": "Include imputed wages", "type": "boolean", "description": "Fill missing wages with the provider's modelled wage estimates.", "default": false }, "filters": { "title": "Advanced filters", "type": "array", "description": "Power users: an array of filter objects `[{ \"field\": \"title\", \"key\": \"data engineer\", \"filterType\": \"contains\" }]`. Appended to the filters built from the fields above. `field` can be title, occupation, industry, skill or keyword." }, "startRecord": { "title": "Start record", "minimum": 1, "type": "integer", "description": "1-based record to start from. Increase to skip earlier results.", "default": 1 }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many job postings (1-5,000). Paged automatically. You are charged per result returned." }, "apiKey": { "title": "API key", "type": "string", "description": "Your labor market data API key. Required. It is provisioned by the provider for your licensed account and sent as an `EQ-Key` credential. Stored securely and never logged." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }