/jobs

post

https://api.priceapi.com/v2/jobs

Step 1: Create a new job.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

token

string

required

Your API key

source

string

required

Defaults to google_shopping

Name of the data source to request from

country

string

required

Defaults to us

Lower case alpha-2 country code of the source to request from (like us, gb, de, ...)

topic

string

required

Defaults to search_results

What type of content to collect. Different topics exist per source. (Like search_results, offers, product, ...

key

string

required

Defaults to term

The type of identifier you want to use. Different keys exist per topic. (id, term, gtin)

values

string

required

Defaults to apple iphone 6S 64GB gold

The identifiers you want to request, separated by newline characters

max_pages

string

Defaults to 3

Prices may be paginated. How many pages do you want to request? Integer; default is 1.

max_age

string

Defaults to 1440

How current should the data be? Give a maximum number of minutes. Integer; different defaults for each topic

timeout

string

Defaults to 100

Number of minutes after which to stop collecting data and finishing the job. Integer; default is 1,440 minutes (24 hours).

webhook_url

string

Webhook Url will be requested once the job finishes

webhook_method

string

enum

HTTP method for initializing the webhook_url; default is POST

Allowed:

webhook_download_format

string

enum

Defines the format of the Job result which is being generated; default format is json; not all topics support these download formats, more details can be found in the dedicated Webhooks article

Allowed:

Responses

Language

Credentials

Query

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

401401