turtlebasket
/
JobSpy
mirror of https://github.com/Bunsly/JobSpy
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: update README.md

pull/12/head
Cullen 2023-08-23 18:07:55 -05:00 committed by GitHub
parent 881ae37ff2
commit a6379110c2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -32,8 +32,6 @@
## Response
Upon successful query, the API will return a JSON object with the following schema:
### Schema
#### JobResponse
@ -45,13 +43,13 @@ Upon successful query, the API will return a JSON object with the following sche
#### JobPost
- **title**: str - Title of the job.
- **company_name**: str - Company offering the job.
- **job_url**: str - URL to the job posting.
- **location**: object - Contains the location details (country, city, state, postal_code, address).
- **description**: str - Description of the job.
- **job_type**: str - Type of job (fulltime, parttime, internship, contract).
- **compensation**: object - Contains compensation details (interval, min_amount, max_amount, currency).
- **date_posted**: str - The date when the job was posted.
- **company_name**: str
- **job_url**: str
- **location**: object - (country, city, state, postal_code, address)
- **description**: str
- **job_type**: str - Options: `fulltime`, `parttime`, `internship`, `contract`
- **compensation**: object - Contains: `interval`, `min_amount`, `max_amount`, `currency`
- **date_posted**: str
### Example
![image](https://github.com/cullenwatson/jobspy/assets/78247585/73cb4423-8a53-456a-9da5-9ce7c56d5282)