{ "openapi": "3.0.1", "info": { "title": "Job Postings Analytics API - Labor Market Hiring Trends", "description": "Rank job postings by top hiring companies, in-demand titles, skills, occupations and locations from a labor market dataset, filtered by date, title, company, skill and geography. Export ranked results with posting counts. Pay per result. Bring your own API key.", "version": "0.1", "x-build-id": "HqL2PSEbjxdLHGeHS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~job-postings-analytics-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-job-postings-analytics-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-postings-analytics-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-job-postings-analytics-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-postings-analytics-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-job-postings-analytics-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": { "facet": { "title": "Rank by", "enum": [ "company_name", "title_name", "skills_name", "occupation_name", "city_name", "state_name", "soc_name" ], "type": "string", "description": "The dimension to rank job postings by. Each ranked bucket becomes one row - for example the top hiring companies, most in-demand job titles, or most requested skills for your filter.", "default": "company_name" }, "rankBy": { "title": "Ranking metric", "enum": [ "unique_postings", "total_postings" ], "type": "string", "description": "Which posting count to rank and sort by.", "default": "unique_postings" }, "startMonth": { "title": "Start month", "type": "string", "description": "Start of the posting date window, as YYYY-MM, e.g. `2025-01`. Leave blank for the provider default window." }, "endMonth": { "title": "End month", "type": "string", "description": "End of the posting date window, as YYYY-MM, e.g. `2025-12`. Leave blank for the provider default window." }, "titles": { "title": "Job titles", "type": "array", "description": "Restrict to postings with these job titles, e.g. `Data Engineer`, `Registered Nurse` (matches the `title_name` filter). Combined as OR.", "items": { "type": "string" } }, "companies": { "title": "Companies", "type": "array", "description": "Restrict to postings from these companies, e.g. `Amazon`, `Deloitte` (matches the `company_name` filter). Combined as OR.", "items": { "type": "string" } }, "skills": { "title": "Skills", "type": "array", "description": "Restrict to postings requiring these skills, e.g. `Python`, `Project Management` (matches the `skills_name` filter). Combined as OR.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "Restrict to postings in these cities, e.g. `Seattle`, `Austin` (matches the `city_name` filter). Combined as OR.", "items": { "type": "string" } }, "states": { "title": "States", "type": "array", "description": "Restrict to postings in these states, e.g. `Washington`, `Texas` (matches the `state_name` filter). Combined as OR.", "items": { "type": "string" } }, "rawFilter": { "title": "Advanced filter", "type": "object", "description": "Power users: a raw filter object merged into the request, e.g. `{ \"naics\": [\"5415\"], \"soc\": [\"15-1252\"] }`. See the provider's job postings API documentation for all supported filter fields." }, "scope": { "title": "API scope", "type": "string", "description": "OAuth scope for the job postings product your credentials are licensed for. Default `postings:us`. Use the region scope that matches your account (for example a global or country job postings scope).", "default": "postings:us" }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Number of ranked buckets to return (1-1,000). You are charged per result returned." }, "clientId": { "title": "Client ID", "type": "string", "description": "Your OAuth client ID for the job postings API. Required." }, "apiKey": { "title": "Client secret", "type": "string", "description": "Your OAuth client secret for the job postings API. Required. 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 } } } } } } } } } }