{ "openapi": "3.0.1", "info": { "title": "Government Jobs API: USAJOBS", "description": "Open US federal government jobs from the official USAJOBS Search API: search by keyword, location, agency, occupation, grade, salary, schedule and hiring path. Clean rows with pay, grades, closing dates and apply links. Monitor mode returns only new jobs.", "version": "0.1", "x-build-id": "ekfpP7T7xnkpxqwBT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yourevenings~government-jobs-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yourevenings-government-jobs-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/yourevenings~government-jobs-api/runs": { "post": { "operationId": "runs-sync-yourevenings-government-jobs-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/yourevenings~government-jobs-api/run-sync": { "post": { "operationId": "run-sync-yourevenings-government-jobs-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": { "keywords": { "title": "Keywords", "type": "array", "description": "Words to search for in job announcements, e.g. \"data scientist\" or \"nurse\". Each keyword is a separate search and results are merged without duplicates. Leave empty to list all open jobs that match the other filters.", "items": { "type": "string" } }, "positionTitle": { "title": "Job title contains", "type": "string", "description": "Match words in the job title only, e.g. \"Program Analyst\"." }, "locations": { "title": "Locations", "type": "array", "description": "City, state or country names as USAJOBS writes them, e.g. \"Denver, Colorado\", \"Texas\" or \"Germany\". Several locations are combined with OR.", "items": { "type": "string" } }, "radiusMiles": { "title": "Radius (miles)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Search this many miles around each location. Only used with Locations." }, "remote": { "title": "Remote work", "enum": [ "any", "remoteOnly", "excludeRemote" ], "type": "string", "description": "Filter on the announcement’s remote-job flag.", "default": "any" }, "teleworkOnly": { "title": "Telework-eligible or remote only", "type": "boolean", "description": "Keep only jobs marked telework-eligible or remote.", "default": false }, "organizationCodes": { "title": "Agency codes", "type": "array", "description": "USAJOBS agency or sub-agency codes, e.g. \"HE\" (Health and Human Services), \"AF\" (Air Force) or \"HE38\" (NIH). Several codes are combined with OR. Codes are listed at https://data.usajobs.gov/api/codelist/agencysubelements.", "items": { "type": "string" } }, "jobCategoryCodes": { "title": "Occupational series", "type": "array", "description": "4-digit OPM occupational series codes, e.g. \"2210\" (IT management), \"0343\" (management and program analysis), \"1102\" (contracting), \"0610\" (nurse).", "items": { "type": "string" } }, "payGradeLow": { "title": "Lowest GS grade", "minimum": 1, "maximum": 15, "type": "integer", "description": "Lowest General Schedule (GS) grade, 1 to 15." }, "payGradeHigh": { "title": "Highest GS grade", "minimum": 1, "maximum": 15, "type": "integer", "description": "Highest General Schedule (GS) grade, 1 to 15." }, "minSalaryUsd": { "title": "Minimum salary (USD a year)", "minimum": 0, "type": "integer", "description": "Keep jobs whose top of the pay range is at least this much a year. Hourly, daily, weekly, two-weekly and monthly pay is converted to a yearly figure (2,087 hours a year, the federal standard). Jobs without a convertible pay range are left out when this is set." }, "scheduleTypes": { "title": "Work schedule", "type": "array", "description": "Full-time, part-time, shift work, intermittent, job sharing or multiple schedules.", "items": { "type": "string", "enum": [ "full-time", "part-time", "shift-work", "intermittent", "job-sharing", "multiple" ] } }, "appointmentTypes": { "title": "Appointment type", "type": "array", "description": "Permanent, temporary, term, seasonal, internships and so on.", "items": { "type": "string", "enum": [ "permanent", "temporary", "term", "detail", "temporary-promotion", "seasonal", "summer", "recent-graduates", "multiple", "internships", "intermittent" ] } }, "hiringPaths": { "title": "Hiring paths", "type": "array", "description": "Who the job is open to, e.g. public (US citizens), vet (veterans), student, graduates, mspouse (military spouses), fed-competitive (current federal employees).", "items": { "type": "string", "enum": [ "public", "vet", "nguard", "disability", "native", "mspouse", "student", "ses", "peace", "overseas", "fed-internal-search", "graduates", "fed-excepted", "fed-competitive", "fed-transition", "land", "special-authorities" ] } }, "postedWithinDays": { "title": "Posted within (days)", "minimum": 0, "maximum": 60, "type": "integer", "description": "Only jobs posted in the last N days (1 to 60). 0 means any date.", "default": 7 }, "closingWithinDays": { "title": "Closing within (days)", "minimum": 0, "type": "integer", "description": "Only jobs whose application window closes within N days. 0 means no limit. Jobs already closed are always left out." }, "sortBy": { "title": "Sort by", "enum": [ "newest", "closingSoonest", "salaryHighest", "relevance" ], "type": "string", "description": "Order in which USAJOBS returns jobs.", "default": "newest" }, "maxResults": { "title": "Max jobs", "minimum": 0, "type": "integer", "description": "Stop after this many job rows. 0 means no limit (USAJOBS returns at most 10,000 jobs per search).", "default": 50 }, "includeFullDescription": { "title": "Include full announcement text", "type": "boolean", "description": "Add duties, education, requirements, evaluation, how to apply, required documents, benefits and other information. Makes rows much larger.", "default": false }, "includeContactDetails": { "title": "Include agency contact email and phone", "type": "boolean", "description": "Off by default: agency contact emails and phone numbers are dropped and masked in text. Turn on only if you need them for a lawful purpose, such as asking about a specific job.", "default": false }, "monitorMode": { "title": "Monitor mode (new jobs only)", "type": "boolean", "description": "Remember jobs already returned and return only new ones on later runs. Schedule the Actor daily to get a feed of new federal jobs. A small alert fee is charged only on runs that return new jobs.", "default": false }, "emitBaselineOnFirstRun": { "title": "Return current jobs on the first monitor run", "type": "boolean", "description": "On the first monitor run, return the jobs open now. Turn off to save them silently as a baseline (nothing charged per job) and get only new jobs from the next run.", "default": true }, "stateStoreName": { "title": "Monitor state store", "type": "string", "description": "Named key-value store that remembers jobs already returned. Use a different name for each saved search.", "default": "government-jobs-api-state" }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 10, "maximum": 180, "type": "integer", "description": "Timeout for each USAJOBS request.", "default": 60 } } }, "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 } } } } } } } } } }