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:08:48 -05:00 committed by GitHub
parent a6379110c2
commit 18dc9a6cf8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -35,14 +35,14 @@
### Schema ### Schema
#### JobResponse #### JobResponse
- **success**: bool - Indicates if the request was successful. - **success**: bool - Indicates if the request was successful
- **error**: str - Any error messages, null if no error. - **error**: str - Any error messages, null if no error
- **jobs**: list[JobPost] - A list of job postings. - **jobs**: list[JobPost] - A list of job postings
- **total_results**: int - Total number of results found. - **total_results**: int - Total number of results found
- **returned_results**: int - Number of results returned in this request. - **returned_results**: int - Number of results returned in this request
#### JobPost #### JobPost
- **title**: str - Title of the job. - **title**: str
- **company_name**: str - **company_name**: str
- **job_url**: str - **job_url**: str
- **location**: object - (country, city, state, postal_code, address) - **location**: object - (country, city, state, postal_code, address)