{ "openapi": "3.0.1", "info": { "title": "Company Hiring Signals API: Open Roles by Department", "description": "Turn a list of company career pages into hiring signals: open roles by department and function, seniority mix, locations, remote share, posting velocity, hiring surge flags and change since the last run. Official public job-board endpoints of 7 ATS, no proxies.", "version": "0.1", "x-build-id": "szXLTs8fJzAfIb93W" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/interconnected_seaport~ats-hiring-signals/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-interconnected_seaport-ats-hiring-signals", "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/interconnected_seaport~ats-hiring-signals/runs": { "post": { "operationId": "runs-sync-interconnected_seaport-ats-hiring-signals", "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/interconnected_seaport~ats-hiring-signals/run-sync": { "post": { "operationId": "run-sync-interconnected_seaport-ats-hiring-signals", "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", "required": [ "companies" ], "properties": { "companies": { "title": "Companies", "type": "array", "description": "Company slugs (\"figma\"), slugs with ATS (\"greenhouse:figma\") or career page URLs (e.g. https://jobs.lever.co/spotify). Without an ATS prefix all 7 supported systems are probed (Greenhouse, Lever, Ashby, SmartRecruiters, Recruitee, Teamtailor, Personio). Max 1,000.", "items": { "type": "string" } }, "maxCompanies": { "title": "Max companies", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Upper limit of companies analyzed (and charged) in this run; extra entries are skipped.", "default": 100 }, "compareToLastRun": { "title": "Compare to last run", "type": "boolean", "description": "Store the open roles of each company between runs and report new roles, closed roles and the change in open roles. The first run has no comparison (changeSinceLastRun is null). Schedule the actor weekly to track growth.", "default": true }, "includeTopTitles": { "title": "Include top job titles", "type": "boolean", "description": "Add the 10 most common job titles per company (topTitles).", "default": true }, "departmentKeywordGroups": { "title": "Custom function keyword groups", "type": "object", "description": "Optional. Maps a function name to title/department keywords, e.g. {\"sales\": [\"account executive\", \"sdr$\"], \"climate\": [\"carbon\", \"sustainab\"]}. An existing name (engineering, sales, marketing, product, design, data_ai, customer_success_support, operations, finance, legal, hr_recruiting, security, executive) replaces its default keywords; a new name is added as an extra key of rolesByFunction and takes priority. Keyword syntax is described in the README." }, "concurrency": { "title": "Concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Companies fetched in parallel. Keep low to be polite to the job-board servers.", "default": 5 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }