hired.search.sources.usajobs#

USAJobs source adapter.

Accesses the official US Government jobs API (https://developer.usajobs.gov/). Requires a free API key obtained from the USAJobs Developer Portal.

Functions

get_usajobs_source()

Get the default USAJobs source instance.

Classes

USAJobsSource([api_key, email])

USAJobs API source implementation.
class hired.search.sources.usajobs.USAJobsSource(api_key=None, email=None)[source]#

Bases: JobSearchSource

USAJobs API source implementation.

Searches US Government job postings via the official USAJobs API. Requires a free API key from https://developer.usajobs.gov/.

property display_name: str#

Return the display name of this source (e.g., ‘Indeed’, ‘USAJobs’).

get_setup_instructions()[source]#

Return setup instructions for this source.

Should include:

  • Where to get API keys if needed

  • Environment variables or config file settings

  • URLs for documentation

Return type:

str

Returns:

Multi-line string with setup instructions.

is_configured()[source]#

Check if this source is properly configured.

Return type:

bool

Returns:

True if the source is ready to use, False otherwise.

property name: str#

Return the name of this source (e.g., ‘indeed’, ‘usajobs’).

property requires_auth: bool#

Return True if this source requires authentication/API keys.

search(criteria)[source]#

Search for jobs using USAJobs API.

Parameters:

criteria (SearchCriteria) – Search criteria

Return type:

List[JobResult]

Returns:

List of JobResult objects

hired.search.sources.usajobs.get_usajobs_source()[source]#

Get the default USAJobs source instance.

Return type:

USAJobsSource