turtlebasket
/
JobSpy
mirror of https://github.com/Bunsly/JobSpy
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Jobs scraper library for LinkedIn, Indeed, Glassdoor & ZipRecruiter
58 Commits
2 Branches
78 Tags
2.7 MiB
Python 100%
 
Go to file
Cullen Watson 2b63d4c84f Merge branch 'main' of https://github.com/JobSpy-ai/backend 2023-07-10 22:25:29 -05:00
api feat(jobs): remove pages for results_wanted 2023-07-10 22:24:02 -05:00
postman chore: move postman files into dir 2023-07-10 22:24:02 -05:00
.gitignore feat(auth): add auth to jobs endpoint 2023-07-10 22:23:05 -05:00
README.md docs: add readme 2023-07-10 22:24:02 -05:00
main.py feat(users): add register route 2023-07-10 22:23:16 -05:00
requirements.txt feat(users): add register route 2023-07-10 22:23:16 -05:00
settings.py feat(jobs): remove pages for results_wanted 2023-07-10 22:24:02 -05:00

README.md

JobSpy Backend

JobSpy Backend is a RESTful API built with FastAPI that allows users to scrape job postings from various job boards such as LinkedIn, Indeed, and ZipRecruiter.

Features

  • User authentication and token-based authorization
  • Scraping job postings from LinkedIn, Indeed, and ZipRecruiter
  • Detailed job data including title, location, company, and more

Endpoints

  • /api/v1/jobs/: POST endpoint to scrape jobs. Accepts parameters for site_type (job board), search term, location, distance, and results wanted.
  • /api/auth/token/: POST endpoint for user authentication. Returns an access token.
  • /api/auth/register/: POST endpoint to register a new user.
  • /health: GET endpoint for a simple health check of the application.

Installation

  1. Clone this repository.
  2. Install the dependencies with pip install -r requirements.txt.
  3. Run the server with uvicorn main:app --reload.

Usage

Visit http://localhost:8000/docs in your web browser to see the automatic interactive API documentation.