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

fix readme

pull/20/head
Cullen Watson 2023-08-27 16:23:36 -05:00
parent 73d1e2838a
commit ebe2bdc2aa
2 changed files with 92 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -13,18 +13,19 @@ POST `/api/v1/jobs/`
### Request Schema ### Request Schema
```plaintext ```plaintext
Request {
├── Required Required
│ ├── site_type (List[enum]): linkedin, zip_recruiter, indeed ├── site_type (List[enum]): linkedin, zip_recruiter, indeed
│ └── search_term (str) └── search_term (str)
└── Optional Optional
├── location (int) ├── location (int)
├── distance (int) ├── distance (int)
├── job_type (enum): fulltime, parttime, internship, contract ├── job_type (enum): fulltime, parttime, internship, contract
├── is_remote (bool) ├── is_remote (bool)
├── results_wanted (int): per site_type ├── results_wanted (int): per site_type
└── easy_apply (bool): only for linkedin ├── easy_apply (bool): only for linkedin
└── output_format (enum): json, csv └── output_format (enum): json, csv
}
``` ```
### Request Example ### Request Example
@ -35,15 +36,15 @@ Request
"location": "austin, tx", "location": "austin, tx",
"distance": 10, "distance": 10,
"job_type": "fulltime", "job_type": "fulltime",
"results_wanted": 15, "results_wanted": 15
"output_format": "json"
} }
``` ```
### Response Schema ### Response Schema
```plaintext ```plaintext
site_type (enum) {
└── response (SiteResponse) site_type (enum): {
JobResponse
├── success (bool) ├── success (bool)
├── error (str) ├── error (str)
├── jobs (List[JobPost]) ├── jobs (List[JobPost])
@ -61,10 +62,14 @@ site_type (enum)
│ │ ├── interval (CompensationInterval): yearly, monthly, weekly, daily, hourly │ │ ├── interval (CompensationInterval): yearly, monthly, weekly, daily, hourly
│ │ ├── min_amount (float) │ │ ├── min_amount (float)
│ │ ├── max_amount (float) │ │ ├── max_amount (float)
│ │ └── currency (str) │ │ └── currency (str): default is "US"
│ └── date_posted (datetime) │ └── date_posted (datetime)
│
├── total_results (int) ├── total_results (int)
└── returned_results (int) └── returned_results (int)
}, ...
}
``` ```
### Response Example (JSON) ### Response Example (JSON)

112
postman/JobSpy.postman_collection.json
View File

File diff suppressed because one or more lines are too long