{ "openapi": "3.0.1", "info": { "title": "Arbeitsagentur Jobs in English + Salary & Market Insights", "description": "Official Arbeitsagentur jobs API data: English fields, normalized salary, market-insight summaries and change tracking for German job listings.", "version": "0.1", "x-build-id": "Pa6l1WKxwLynfLqZO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zerahdata~arbeitsagentur-jobs-insights/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zerahdata-arbeitsagentur-jobs-insights", "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/zerahdata~arbeitsagentur-jobs-insights/runs": { "post": { "operationId": "runs-sync-zerahdata-arbeitsagentur-jobs-insights", "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/zerahdata~arbeitsagentur-jobs-insights/run-sync": { "post": { "operationId": "run-sync-zerahdata-arbeitsagentur-jobs-insights", "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": { "keywords": { "title": "Keywords (job titles)", "type": "array", "description": "One or more German job titles/keywords to search for (searched against the official \"was\" field). Example: \"Softwareentwickler\".", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "A German city, postal code or region to search around (the official \"wo\" field). Leave empty to search all of Germany." }, "radiusKm": { "title": "Radius (km)", "minimum": 0, "maximum": 200, "type": "integer", "description": "Search radius around \"Location\" in kilometers. Ignored when Location is empty.", "default": 25 }, "searches": { "title": "Advanced: keyword | location pairs", "type": "array", "description": "Optional. Advanced alternative to Keywords/Location: a list of \"keyword | location\" pairs, one search per line, e.g. \"Pflegefachkraft | München\". When non-empty, this replaces Keywords/Location and each pair uses the same Radius (km)/filters below. Leave empty to just use Keywords + Location.", "default": [], "items": { "type": "string" } }, "offerType": { "title": "Offer type", "enum": [ "job", "apprenticeship", "internship", "selfEmployment" ], "type": "string", "description": "Type of listing to search for (the official \"angebotsart\" field).", "default": "job" }, "contractType": { "title": "Contract type", "enum": [ "any", "permanent", "fixedTerm" ], "type": "string", "description": "Filter by contract duration (the official \"befristung\" field).", "default": "any" }, "workingTime": { "title": "Working time", "type": "array", "description": "Filter by working-time pattern (the official \"arbeitszeit\" field). Note: the official API has no server-side home-office filter, so \"Home office possible\" is applied after fetching, by checking each listing's remote-work flag.", "items": { "type": "string", "enum": [ "fullTime", "partTime", "shiftNightWeekend", "minijob", "homeOffice" ], "enumTitles": [ "Full-time", "Part-time", "Shift/night/weekend", "Minijob", "Home office possible" ] }, "default": [] }, "postedWithinDays": { "title": "Posted within (days)", "minimum": 0, "maximum": 100, "type": "integer", "description": "Optional. Only return listings published within this many days (the official \"veroeffentlichtseit\" field, 0-100). Leave empty for no limit." }, "excludeTemporaryAgencies": { "title": "Exclude temporary work agencies", "type": "boolean", "description": "When on, excludes listings from temporary work agencies (Zeitarbeit, \"zeitarbeit=false\").", "default": false }, "excludePrivateAgencies": { "title": "Exclude private placement agencies", "type": "boolean", "description": "When on, excludes listings placed via private placement agencies (\"pav=false\").", "default": false }, "employer": { "title": "Employer (exact name)", "type": "string", "description": "Optional. Filter to one employer. Must match the official employer name exactly as Arbeitsagentur stores it (e.g. \"Deutsche Bahn AG\"), not a partial/fuzzy name.", "default": "" }, "maxResults": { "title": "Max results per search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of job listings to fetch for each search (each keyword+location pair, or each row of the advanced \"searches\" list). The official API caps any single search at 10,000 matching results; this actor automatically splits large searches into date-window batches to reach higher totals where possible.", "default": 20 }, "includeDetails": { "title": "Fetch full job details", "type": "boolean", "description": "When on (default), fetches the full description and extra fields for every listing from the job-details endpoint. Turn off for a faster, lighter run using only search-result fields (no description, no detailed salary parsing from text).", "default": true }, "descriptionFormat": { "title": "Description format", "enum": [ "markdown", "text" ], "type": "string", "description": "Whether to keep the job description as markdown (as published) or convert it to plain text.", "default": "text" }, "translateTo": { "title": "Translate title/description to", "enum": [ "none", "en", "es", "fr", "pl", "tr", "ru", "ar", "uk", "ro", "it", "pt" ], "type": "string", "description": "Optional. Translates the job title and description into this language using your own DeepL or Google Cloud Translation API key. Leave as \"none\" to skip translation (default).", "default": "none" }, "translationProvider": { "title": "Translation provider", "enum": [ "deepl", "google" ], "type": "string", "description": "Which translation API to call. Ignored when \"Translate title/description to\" is \"none\".", "default": "deepl" }, "translationApiKey": { "title": "Translation API key", "type": "string", "description": "Your own DeepL or Google Cloud Translation API key. Never logged or included in output. Ignored when \"Translate title/description to\" is \"none\"." }, "currency": { "title": "Convert salary to currency", "enum": [ "EUR", "USD", "GBP", "CHF", "ILS" ], "type": "string", "description": "Annualized salary figures are additionally converted to this currency using the European Central Bank's daily reference rate (fetched once per run). Original EUR figures are always kept.", "default": "EUR" }, "trackChanges": { "title": "Track new/removed jobs between runs", "type": "boolean", "description": "When enabled, the actor remembers what it saw last time (in a named key-value store) and every run after the first emits a free \"change\" row: new listings, listings no longer available, and how the total market size moved. Combine with a schedule for ongoing monitoring.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Name of the key-value store used to persist state when \"Track new/removed jobs\" is on, stored as \"arbeitsagentur-jobs-monitor-\". Use the same name across scheduled runs of the same search; use different names to keep multiple monitors independent. Leave empty to use \"default\".", "default": "" }, "outputMode": { "title": "Output mode", "enum": [ "all", "jobsOnly", "summaryOnly" ], "type": "string", "description": "\"all\" (default): job, summary and change rows. \"jobsOnly\": only job rows (no summary/change rows). \"summaryOnly\": only summary/change rows, no individual job rows (cheapest - summary/change rows are always free).", "default": "all" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Not required to call the official Jobsuche API, but can help if you run many searches from a shared environment.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }