Python SDK

Install the JobSphere API

The official Python client for the JobSphere API. Integrate job board functionality, automate hiring workflows, and manage applications programmatically in just a few lines of code.

Quick Installation

bash

pip install jobsphere-api

Requires Python 3.8+. Compatible with pip, conda, and Poetry.

Prerequisites

Python Environment

Ensure Python 3.8 or higher is installed. We recommend using a virtual environment like venv or conda.

API Credentials

Generate your API key from the JobSphere Dashboard. Keep it secure and never commit it to public repositories.

Verification

After installation, verify your setup by importing the package and checking the version:

python

import jobsphere
print(jobsphere.__version__)
# Output: 1.2.4

Quick Start

Authenticate and fetch your first job listing in under a minute:

python

import os
from jobsphere import Client, JobListing

# Initialize with your API key
client = Client(api_key=os.getenv("JOBSHERE_API_KEY"))

# Search for remote Python developer roles
jobs = client.jobs.search(
    query="Python Developer",
    location="Remote",
    remote_only=True,
    limit=5
)

for job in jobs.results:
    print(ff{job.title} @ {job.company.name})
    print(f  Salary: {job.salary_range})
    print(f  URL: {job.apply_url})
    print("-" * 40)

Configuration Options

Customize the client behavior to match your application's requirements:

python

from jobsphere import Client, Config

config = Config(
    timeout=30,           # Request timeout in seconds
    retries=3,             # Automatic retry attempts
    base_url="https://api.jobsphere.io/v2",  # Sandbox or production
    proxy="http://localhost:8080"   # Optional proxy support
)

client = Client(config=config)

Common Use Cases

Method	Description	Rate Limit
`client.jobs.search()`	Find jobs by keyword, location, or tags	100 req/min
`client.jobs.get(id)`	Fetch full details of a specific listing	300 req/min
`client.applications.create()`	Submit resume & cover letter programmatically	30 req/min
`client.webhooks.subscribe()`	Listen for new job postings or status changes	Unlimited

Pro Tip: Use jobsphere[async] to install the asyncio-compatible version for high-throughput scraping or webhook handlers.

Read Full Documentation View on GitHub