priceapi

Suggest Edits

Version 2 is production-ready

 

Ready to use in production

Specification of version 2 is stable and after extensive testing, version 2 is ready for production use as of today.

Suggest Edits

Request process overview

Three steps to the data you need

 

Getting data is a three-step process:

  1. First you submit a job that specifies which data you want. As a result, you receive a job_id.
  2. Then you wait for the job to finish. You can request the job's status until it is finished.
  3. When the job is finished, you can download the job's results in a format you choose.
Suggest Edits

/jobs

Step 1: Create a new job.

 

Query Auth

 Authentication is required for this endpoint.
posthttps://api.priceapi.com/v2/jobs
# Assuming you stored your API key in environment variable PRICEAPI_TOKEN
curl -X POST https://api.priceapi.com/v2/jobs \
    -d "token=$PRICEAPI_TOKEN" \
    -d 'source=test' \
    -d 'country=us' \
    -d 'topic=search_results' \
    -d 'key=gtin' \
    -d 'values=00885909666966
               08718108041581'
require "uri"
require "net/http"
require "json"

ENDPOINT = "https://api.priceapi.com/v2"

create_response = Net::HTTP.post_form(
  URI("#{ENDPOINT}/jobs"),
  token: ENV["PRICEAPI_TOKEN"],
  source: "google-shopping",
  country: "us", # alpha-2 country code, but lower-case
  topic: "search_results",
  key: "keyword",
  values: ["apple iphone 6S 64GB gold"].join("\n")
)
create_hash = JSON.parse(create_response.body)
job_id = create_hash["job_id"]
job_status = create_hash["status"]
puts "Created job #{job_id}"

# TODO: Add logging, error handling, retries and metrics.
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
{
  "job_id": "1234567890abcdef12345678",
  "status": "new",
  "requested": 2
}
{
  "success": false,
  "reason": "missing parameter",
  "parameter": "key",
  "comment": "Provide the mandatory parameter 'key'!"
}
{
  "success": false,
  "reason": "unauthorized",
  "parameter": "token",
  "comment": "Provide your API key with the parameter 'token'!"
}

Body Params

token
string
required

Your API key

source
string
required

Name of the data source to request from

country
string
required

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

topic
string
required

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

key
string
required

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

values
string
required

The identifiers you want to request, separated by newline characters

max_pages
string

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

max_age
string

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

timeout
string

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

 

Size limit

We limit the number of items that can be requested in a single job to 1,000. If you want to request more than 1,000 products, you can run multiple jobs in parallel.

JSON response

The only relevant information in the JSON response is the job_id. Save this value for steps 2 and 3.

Errors

An error is indicated by an HTTP status code in the 4xx and 5xx ranges. If the error happens on an application level, we try to provide an explanation in JSON.

Non-JSON responses

If something goes wrong somewhere deeper in our stack (say on a load balancer), we might return a different kind of response (like HTML or text).

Example error response

{
  "success": false,
  "reason": "unauthorized",
  "parameter": "token",
  "comment": "Provide your API key with the parameter 'token'!"
}
 
<html><body><h1>503 Service Unavailable</h1>
No server is available to handle this request.
</body></html>

List of error codes

Error code
Meaning

unauthorized

No token given or token is not valid.

missing parameter

Not all required parameters were given.

parameter value invalid

Given value is not allowed for this parameter.

unknown source

Chosen source is not supported (yet).

unsupported country

Chosen country is not supported for the chosen source.

unsupported key

Chosen key is not supported by the chosen source.

source disabled

Combination of source and country is temporarily disabled.

key disabled

Chosen key is temporarily disabled for this source and country.

value disabled

Chosen value is temporarily disabled for this source, country and key.

not enough free credits

Not enough free credits left for the given request, a paid subscription is needed.

daily quota exceeded

User-defined daily quota is exceeded. You can change this. See Daily quota.

too many values

Requested more than 1,000 values in one job.

Further error codes may be added.

Suggest Edits

/jobs/:job_id

Step 2: Request a job's status until it is finished.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.priceapi.com/v2/jobs/job_id
# Assuming you stored your API key in environment variable PRICEAPI_TOKEN
curl https://api.priceapi.com/v2/jobs/1234567890abcdef12345678?token=$PRICEAPI_TOKEN
require "rest-client" # gem install rest-client
require "json"

ENDPOINT = "https://api.priceapi.com/v2"
job_id = "<the job_id from step 1>"

until ["finished", "cancelled"].include?(job_status)
  sleep 5 # In production, please use 30-60 seconds
  status_uri = URI("#{ENDPOINT}/jobs/#{job_id}?token=#{ENV["PRICEAPI_TOKEN"]}")
  status_response = Net::HTTP.get_response(status_uri)
  status_hash = JSON.parse(status_response.body)
  job_status = status_hash["status"]
  puts "Job #{job_id} status #{job_status}"
end

unless job_status == "finished"
  puts "Job #{job_id} terminated in status #{job_status}"
  exit 1
end

# TODO: Add logging, error handling, retries and metrics.
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
{
  "job_id": "1234567890abcdef12345678",
  // Wait until status is "finished".
  "status": "working",
  "progress": 50, // 0 to 100
  "requested": 2,
  "completed": 1
}

{
  "success": false,
  "reason": "job not found",
  "comment": "No job found for the given job id '1234567890abcdef12345678'!"
}
{
  "job_id": "1234567890abcdef12345678",
  // Wait until status is "finished".
  "status": "finished",
  // Progress can be 100 before.
  "progress": 100,
  "requested": 2,
  "completed": 2
}
{
  "success": false,
  "reason": "too many requests",
  "allowed requests per minute": 60,
  "comment": "You have exceeded the amount of requests for this url type."
}

Path Params

job_id
string
required

The id of a recently created job. Found in the JSON response of the create request.

Query Params

token
string
required

Your API key

 

List of status codes

Status code
Meaning

new

The job was just received and will be scheduled soon.

working

The job was scheduled and is being worked on according to the scheduling.

finishing

All data for the job has been collected and the results are being compiled.

finished

The job was processed completely and is ready to be downloaded.

cancelled

The job's processing was cancelled. It cannot be downloaded. No credits have been booked for this job.

Further status codes may exist or be added later.

List of error codes

Error code
Meaning

unauthorized

No token given or token is not valid.

job not found

No job could found for given job_id.

job forbidden

User with given token is not allowed access to the given job.

too many requests

Usage of this endpoint is rate limited to 60 requests per minute.

Further error codes may be added.

Suggest Edits

/jobs/:job_id/download

Step 3: Download a finished job's results.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.priceapi.com/v2/jobs/job_id/download
# Assuming you stored your API key in environment variable PRICEAPI_TOKEN
# JSON is the default
curl -L https://api.priceapi.com/v2/jobs/1234567890abcdef12345678/download?token=$PRICEAPI_TOKEN

# Explicitly select JSON
curl -L https://api.priceapi.com/v2/jobs/1234567890abcdef12345678/download.json?token=$PRICEAPI_TOKEN
# Select XML
curl -L https://api.priceapi.com/v2/jobs/1234567890abcdef12345678/download.xml?token=$PRICEAPI_TOKEN
# Select CSV
curl -L https://api.priceapi.com/v2/jobs/1234567890abcdef12345678/download.csv?token=$PRICEAPI_TOKEN&layout=one_offer_per_row
# Select Excel
curl -L https://api.priceapi.com/v2/jobs/1234567890abcdef12345678/download.xlsx?token=$PRICEAPI_TOKEN&layout=one_offer_per_row
require "rest-client" # gem install rest-client
require "json"

ENDPOINT = "https://api.priceapi.com/v2"
job_id = "<the job_id from step 1>"

result_uri =
  URI("#{ENDPOINT}/jobs/#{job_id}/download?token=#{ENV["PRICEAPI_TOKEN"]}")
result_response = Net::HTTP.get_response(result_uri)
if result_response.is_a?(Net::HTTPRedirection)
  result_response = Net::HTTP.get_response(URI(result_response["Location"]))
end
result_hash = JSON.parse(result_response.body)
puts JSON.pretty_generate(result_hash)

# TODO: Add logging, error handling, retries and metrics.
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
{
  "job_id": "1234567890abcdef12345678",
  "status": "finished",
  // used test credits for this request
  "free_credits": 0,
  // used paid credits for this requests
  "paid_credits": 4,
  // array including multiple entries
  "results": [
    // Multiple results here (see below)
  ]
}
{
  "success": false,
  "reason": "job not finished",
  "comment": "The job with id '1234567890abcdef12345678' is not finished, yet! Status: finishing",
  "status": "finishing"
}
HTTP/1.1 302 Found
Location: https://api.priceapi.com/results/1234567890abcdef12345678.json?code=ABC123

Path Params

job_id
string
required

The id of a recently created job. Found in the JSON response of the create request.

Query Params

token
string
required

Your API key

layout
string

Only when format is CSV or Excel. Available layouts depend on the topic, e.g. be one_product_per_row or one_offer_per_row.

 

Follow redirects

For performance reasons, we sometimes pre-render your results. If we do so, we will respond with a redirect. Please make sure, your client follows redirects when you request results.

Result formats

We currently can give you the job results in four different formats:

  • JSON (recommended for integration)
  • XML
  • CSV (for most topics)
  • XSLX (for most topics)
{
  "job_id": "1234567890abcdef12345678",
  "status": "finished",
  "free_credits": 2,
  "paid_credits": 0,
  "results": [
    {
      "query": {
        "source": "test",
        "country": "us",
        "topic": "search_results",
        "key": "gtin",
        "value": "00885909666966",
        "max_pages": 1,
        "max_age": 1200
      },
      "success": true,
      "metadata": {
        "from_cache": false,
        "page_count_delivered": 2,
        "page_count_from_cache": 0,
        "page_count_live": 2,
        "request_count": 3,
        "updated_at": "2017-06-08T12:34:37Z",
        "tag": "2017_06_01-10_03_51"
      },
      "content": {
        "search_results": [
          {
            "id": "product_0",
            "updated_at": "2017-06-08 12:34:37 UTC",
            "url": "https://test.priceapi.com/products/product_0",
            "name": "00885909666966 Result 0"
          },
          {
            "id": "product_1",
            "updated_at": "2017-06-08 12:34:37 UTC",
            "url": "https://test.priceapi.com/products/product_1",
            "name": "00885909666966 Result 1"
          },
	        // ... more search results
        ]
      }
    },
    // ... next search
  ]
}
 
<?xml version="1.0" encoding="UTF-8"?>
<hash>
  <job-id>1234567890abcdef12345678</job-id>
  <status type="symbol">finished</status>
  <free-credits type="integer">2</free-credits>
  <paid-credits type="integer">0</paid-credits>
  <results type="array">
    <result>
      <query>
        <source>test</source>
        <country>us</country>
        <topic>search_results</topic>
        <key>gtin</key>
        <value>00885909666966</value>
        <max-pages type="integer">1</max-pages>
        <max-age type="integer">1200</max-age>
      </query>
      <success type="boolean">true</success>
      <metadata>
        <from-cache type="boolean">false</from-cache>
        <page-count-delivered type="integer">2</page-count-delivered>
        <page-count-from-cache type="integer">0</page-count-from-cache>
        <page-count-live type="integer">2</page-count-live>
        <request-count type="integer">3</request-count>
        <updated-at type="dateTime">2017-06-08T12:34:37Z</updated-at>
      </metadata>
      <content>
        <search-results type="array">
          <search-result>
            <id>product_0</id>
            <updated-at type="dateTime">2017-06-08T12:34:37Z</updated-at>
            <url>https://test.priceapi.com/products/product_0</url>
            <name>00885909666966 Result 0</name>
          </search-result>
          <search-result>
            <id>product_1</id>
            <updated-at type="dateTime">2017-06-08T12:34:37Z</updated-at>
            <url>https://test.priceapi.com/products/product_1</url>
            <name>00885909666966 Result 1</name>
          </search-result>
	        <!-- ... more search results -->
        </search-results>
      </content>
    </result>
    <!-- ... next search -->
  </results>
</hash>

72 hour retention period

Job results are only available for 72 hours after the job was requested. After that we permanently delete the results. So please make sure to download the results shortly after the job finishes.

List of error codes

Error code
Meaning

unauthorized

No token given or token is not valid.

job not found

No job could found for given job_id.

job forbidden

User with given token is not allowed access to the given job.

job not finished

Job processing is still in progress. Wait until its status it is finished.

Further error codes may be added.

Product-level errors

Even when a job is accepted, there may be errors while collecting data on individual products. This is indicated with the success attribute being false and with a given reason attribute.

When an error occurs, we don't deduct any credits. The only exception is for reason not found (see below) as this is a valid response and it takes us the same amount of effort to find this out.

List of reasons

Reason codes
Meaning

not found

We have successfully searched for the given product, but it is not currently present on the source.

invalid value

We have checked the value and found that it is invalid. We did not try to request this. For example, if you search with key=gtin we will check the provided GTIN's checksum.

validation error

We failed to collect valid data for you.

timeout

We could not collect the data in the timespan allowed by you. See job parameter timeout.

source temporary not reachable

We cannot collect data from this source at the moment.

offer not found

A product was found, but it does not currently have any offers.

failed to access source

We cannot collect data from this source at the moment.

cluster not found

Data for the product could not be collected at this time. We expect to be able to collect the data next time you request it.

cluster_gone

Data for the product could not be collected at this time. We have to search for it, which may take a while. We may be able to collect the data next time you request it (generally within the next days).

not_searchable

Data for the product could not be collected and we estimated that we cannot do so in the near future.

to_be_searched

Data for the product could not be collected at this time. We have to search for it, which may take a while. We may be able to collect the data next time you request it (generally within the next days).

error

General error in our processing.

Further reasons may exist or be added later.

Suggest Edits

/me/usage_today

See how many credits you used this day and what your daily quota is.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.priceapi.com/v2/me/usage_today
curl https://api.priceapi.com/v2/me/usage_today?token=$PRICEAPI_TOKEN
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
{
  "usage": {
    "credits": 4,
    "free_credits": 4,
    "paid_credits": 0,
    "date": "2017-04-09",
    "quota": 100000
  }
}
{
  "success": false,
  "reason": "unauthorized",
  "parameter": "token",
  "comment": "Provide your API key with the parameter 'token'!"
}

Query Params

token
string
required

Your API key

 

Days are UTC based, they start and end at midnight UTC.

Suggest Edits

/me/usage_month

See how many credits you used in the current billing period.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.priceapi.com/v2/me/usage_month
curl https://api.priceapi.com/v2/me/usage_month?token=$PRICEAPI_TOKEN
A binary file was returned

You couldn't be authenticated

{{ results.method }}
{{ results.url }}
{{ results.requestHeaders }}
{{ results.data }}
{{ results.responseHeaders }}
{
  "usage": {
    "credits": 61000,
    "free_credits": 1000,
    "paid_credits": 60000,
    "from": "2017-04-01",
    "to": "2017-04-09",
    "included_credits": 50000,
    "overusage": 10000
  },
  "usages": [
    {
      "credits": 10913,
      "free_credits": 1000,
      "paid_credits": 9913,
      "date": "2017-04-04"
    },
    {
      "credits": 12345,
      "free_credits": 0,
      "paid_credits": 12345,
      "date": "2017-04-08"
    },
    {
      "credits": 37742,
      "free_credits": 0,
      "paid_credits": 37742,
      "date": "2017-04-09"
    }
  ]
}
{
  "success": false,
  "reason": "unauthorized",
  "parameter": "token",
  "comment": "Provide your API key with the parameter 'token'!"
}

Query Params

token
string
required

Your API key

 

Days are UTC based, they start and end at midnight UTC.

Suggest Edits

Overview

 

Sources by country

We currently provide data in 28 countries: Australia, Austria, Belgium, Brazil, Canada, Czechia, Denmark, France, Germany, India, Ireland, Italy, Japan, Malaysia, Mexico, Netherlands, Norway, Philippines, Poland, Portugal, Russian Federation, Singapore, Spain, Sweden, Switzerland, Turkey, United Kingdom, and United States

Australia (au)

We currently provide data for Australia from 2 sources (eBay and Google Shopping).

Source eBay (ebay)

Topics:

  • product_and_offers (with keys term, gtin)
  • search_results (with keys term, gtin)

Also see details for eBay.

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Austria (at)

We currently provide data for Austria from 4 sources (eBay, Geizhals, Google Shopping, and Idealo).

Source eBay (ebay)

Topics:

  • product_and_offers (with keys term, gtin)
  • search_results (with keys term, gtin)

Also see details for eBay.

Source Geizhals (geizhals)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin)
  • shop (with key id)

Also see details for Geizhals.

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Source Idealo (idealo)

Topics:

  • offers (with key id)
  • price_history (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin)
  • shop (with key id)
  • top_list (with key id)
  • variants (with key id)

Also see details for Idealo.

Belgium (be)

We currently provide data for Belgium from 2 sources (eBay and Google Shopping).

Source eBay (ebay)

Topics:

  • product_and_offers (with keys term, gtin)
  • search_results (with keys term, gtin)

Also see details for eBay.

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Brazil (br)

We currently provide data for Brazil from 1 source (Google Shopping).

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Canada (ca)

We currently provide data for Canada from 4 sources (Amazon, eBay, Google Shopping, and Test).

Source Amazon (amazon)

Topics:

  • bestsellers (with key id)
  • movers_and_shakers (with key id)
  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, gtin, asin, term)
  • reviews (with key id)
  • search_results (with keys gtin, asin, term)
  • shop (with key id)

Also see details for Amazon.

Source eBay (ebay)

Topics:

  • product_and_offers (with keys term, gtin)
  • search_results (with keys term, gtin)

Also see details for eBay.

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Source Test (test)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin, asin)
  • shop (with key id)

Also see details for Test.

Czechia (cz)

We currently provide data for Czechia from 1 source (Google Shopping).

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Denmark (dk)

We currently provide data for Denmark from 2 sources (Google Shopping and Pricerunner).

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Source Pricerunner (pricerunner)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin)
  • shop (with key id)

Also see details for Pricerunner.

France (fr)

We currently provide data for France from 5 sources (Amazon, eBay, Google Shopping, Idealo, and Test).

Source Amazon (amazon)

Topics:

  • bestsellers (with key id)
  • movers_and_shakers (with key id)
  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, gtin, asin, term)
  • reviews (with key id)
  • search_results (with keys gtin, asin, term)
  • shop (with key id)

Also see details for Amazon.

Source eBay (ebay)

Topics:

  • product_and_offers (with keys term, gtin)
  • search_results (with keys term, gtin)

Also see details for eBay.

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Source Idealo (idealo)

Topics:

  • offers (with key id)
  • price_history (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin)
  • shop (with key id)
  • top_list (with key id)
  • variants (with key id)

Also see details for Idealo.

Source Test (test)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin, asin)
  • shop (with key id)

Also see details for Test.

Germany (de)

We currently provide data for Germany from 9 sources (Amazon, billiger.de, eBay, Geizhals, Google Shopping, Idealo, Medizinfuchs, Pricerunner, and Test).

Source Amazon (amazon)

Topics:

  • bestsellers (with key id)
  • movers_and_shakers (with key id)
  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, gtin, asin, term)
  • reviews (with key id)
  • search_results (with keys gtin, asin, term)
  • shop (with key id)

Also see details for Amazon.

Source billiger.de (billiger)

Topics:

  • product (with key id)
  • product_and_offers (with keys id, asin, gtin, mpn, pzn, term)
  • search_results (with keys asin, gtin, mpn, pzn, term)
  • shop (with key id)
  • top_list (with key id)

Also see details for billiger.de.

Source eBay (ebay)

Topics:

  • product_and_offers (with keys term, gtin)
  • search_results (with keys term, gtin)

Also see details for eBay.

Source Geizhals (geizhals)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin)
  • shop (with key id)

Also see details for Geizhals.

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Source Idealo (idealo)

Topics:

  • offers (with key id)
  • price_history (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin)
  • shop (with key id)
  • top_list (with key id)
  • variants (with key id)

Also see details for Idealo.

Source Medizinfuchs (medizinfuchs)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys term, pzn, id)
  • search_results (with keys term, pzn)
  • shop (with key id)

Also see details for Medizinfuchs.

Source Pricerunner (pricerunner)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin)
  • shop (with key id)

Also see details for Pricerunner.

Source Test (test)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin, asin)
  • shop (with key id)

Also see details for Test.

India (in)

We currently provide data for India from 4 sources (Amazon, eBay, Google Shopping, and Test).

Source Amazon (amazon)

Topics:

  • bestsellers (with key id)
  • movers_and_shakers (with key id)
  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, gtin, asin, term)
  • reviews (with key id)
  • search_results (with keys gtin, asin, term)
  • shop (with key id)

Also see details for Amazon.

Source eBay (ebay)

Topics:

  • product_and_offers (with keys term, gtin)
  • search_results (with keys term, gtin)

Also see details for eBay.

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Source Test (test)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin, asin)
  • shop (with key id)

Also see details for Test.

Ireland (ie)

We currently provide data for Ireland from 1 source (eBay).

Source eBay (ebay)

Topics:

  • product_and_offers (with keys term, gtin)
  • search_results (with keys term, gtin)

Also see details for eBay.

Italy (it)

We currently provide data for Italy from 5 sources (Amazon, eBay, Google Shopping, Idealo, and Test).

Source Amazon (amazon)

Topics:

  • bestsellers (with key id)
  • movers_and_shakers (with key id)
  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, gtin, asin, term)
  • reviews (with key id)
  • search_results (with keys gtin, asin, term)
  • shop (with key id)

Also see details for Amazon.

Source eBay (ebay)

Topics:

  • product_and_offers (with keys term, gtin)
  • search_results (with keys term, gtin)

Also see details for eBay.

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Source Idealo (idealo)

Topics:

  • offers (with key id)
  • price_history (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin)
  • shop (with key id)
  • top_list (with key id)
  • variants (with key id)

Also see details for Idealo.

Source Test (test)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin, asin)
  • shop (with key id)

Also see details for Test.

Japan (jp)

We currently provide data for Japan from 1 source (Google Shopping).

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Malaysia (my)

We currently provide data for Malaysia from 1 source (eBay).

Source eBay (ebay)

Topics:

  • product_and_offers (with keys term, gtin)
  • search_results (with keys term, gtin)

Also see details for eBay.

Mexico (mx)

We currently provide data for Mexico from 2 sources (Amazon and Google Shopping).

Source Amazon (amazon)

Topics:

  • bestsellers (with key id)
  • movers_and_shakers (with key id)
  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, gtin, asin, term)
  • reviews (with key id)
  • search_results (with keys gtin, asin, term)
  • shop (with key id)

Also see details for Amazon.

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Netherlands (nl)

We currently provide data for Netherlands from 2 sources (eBay and Google Shopping).

Source eBay (ebay)

Topics:

  • product_and_offers (with keys term, gtin)
  • search_results (with keys term, gtin)

Also see details for eBay.

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Norway (no)

We currently provide data for Norway from 1 source (Google Shopping).

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Philippines (ph)

We currently provide data for Philippines from 1 source (eBay).

Source eBay (ebay)

Topics:

  • product_and_offers (with keys term, gtin)
  • search_results (with keys term, gtin)

Also see details for eBay.

Poland (pl)

We currently provide data for Poland from 4 sources (Allegro, Cenowarka, eBay, and Google Shopping).

Source Allegro (allegro)

Topics:

  • product_and_offers (with keys term, gtin)
  • search_results (with keys term, gtin)

Also see details for Allegro.

Source Cenowarka (cenowarka)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin)
  • shop (with key id)

Also see details for Cenowarka.

Source eBay (ebay)

Topics:

  • product_and_offers (with keys term, gtin)
  • search_results (with keys term, gtin)

Also see details for eBay.

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Portugal (pt)

We currently provide data for Portugal from 1 source (Google Shopping).

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Russian Federation (ru)

We currently provide data for Russian Federation from 1 source (Google Shopping).

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Singapore (sg)

We currently provide data for Singapore from 1 source (eBay).

Source eBay (ebay)

Topics:

  • product_and_offers (with keys term, gtin)
  • search_results (with keys term, gtin)

Also see details for eBay.

Spain (es)

We currently provide data for Spain from 5 sources (Amazon, eBay, Google Shopping, Idealo, and Test).

Source Amazon (amazon)

Topics:

  • bestsellers (with key id)
  • movers_and_shakers (with key id)
  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, gtin, asin, term)
  • reviews (with key id)
  • search_results (with keys gtin, asin, term)
  • shop (with key id)

Also see details for Amazon.

Source eBay (ebay)

Topics:

  • product_and_offers (with keys term, gtin)
  • search_results (with keys term, gtin)

Also see details for eBay.

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Source Idealo (idealo)

Topics:

  • offers (with key id)
  • price_history (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin)
  • shop (with key id)
  • top_list (with key id)
  • variants (with key id)

Also see details for Idealo.

Source Test (test)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin, asin)
  • shop (with key id)

Also see details for Test.

Sweden (se)

We currently provide data for Sweden from 2 sources (Google Shopping and Pricerunner).

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Source Pricerunner (pricerunner)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin)
  • shop (with key id)

Also see details for Pricerunner.

Switzerland (ch)

We currently provide data for Switzerland from 2 sources (eBay and Google Shopping).

Source eBay (ebay)

Topics:

  • product_and_offers (with keys term, gtin)
  • search_results (with keys term, gtin)

Also see details for eBay.

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Turkey (tr)

We currently provide data for Turkey from 1 source (Google Shopping).

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

United Kingdom (gb)

We currently provide data for United Kingdom from 7 sources (Amazon, eBay, Google Shopping, Idealo, Pricerunner, Skinflint, and Test).

Source Amazon (amazon)

Topics:

  • bestsellers (with key id)
  • movers_and_shakers (with key id)
  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, gtin, asin, term)
  • reviews (with key id)
  • search_results (with keys gtin, asin, term)
  • shop (with key id)

Also see details for Amazon.

Source eBay (ebay)

Topics:

  • product_and_offers (with keys term, gtin)
  • search_results (with keys term, gtin)

Also see details for eBay.

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Source Idealo (idealo)

Topics:

  • offers (with key id)
  • price_history (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin)
  • shop (with key id)
  • top_list (with key id)
  • variants (with key id)

Also see details for Idealo.

Source Pricerunner (pricerunner)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin)
  • shop (with key id)

Also see details for Pricerunner.

Source Skinflint (skinflint)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin)
  • shop (with key id)

Also see details for Skinflint.

Source Test (test)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin, asin)
  • shop (with key id)

Also see details for Test.

United States (us)

We currently provide data for United States from 4 sources (Amazon, eBay, Google Shopping, and Test).

Source Amazon (amazon)

Topics:

  • bestsellers (with key id)
  • movers_and_shakers (with key id)
  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, gtin, asin, term)
  • reviews (with key id)
  • search_results (with keys gtin, asin, term)
  • shop (with key id)

Also see details for Amazon.

Source eBay (ebay)

Topics:

  • product_and_offers (with keys term, gtin)
  • search_results (with keys term, gtin)

Also see details for eBay.

Source Google Shopping (google_shopping)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • product_specs (with key id)
  • search_results (with keys term, gtin)

Also see details for Google Shopping.

Source Test (test)

Topics:

  • offers (with key id)
  • product (with key id)
  • product_and_offers (with keys id, term, gtin)
  • search_results (with keys term, gtin, asin)
  • shop (with key id)

Also see details for Test.

Suggest Edits

Allegro

 

We currently provide data on Allegro (allegro) for 1 country. The data includes search results.

Supported countries:

  • Europe: Poland (pl)

Supported topics:

Jump to: product_and_offers, search_results

Topic product_and_offers

Supported keys:

  • term
  • gtin

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)
  • sort_by (default relevancy_descending)

Topic search_results

Supported keys:

  • term
  • gtin

Supported parameters:

  • max_age (default 38880)
  • max_pages (default 1)
  • sort_by (default relevancy_descending)
Suggest Edits

Amazon

 

Currently in beta

This source is currently in beta. It may still change or contain bugs.

Source available on request

This source can be added to your account by our support team on request.

We currently provide data on Amazon (amazon) for 9 countries. The data includes bestsellers, offers, products, reviews, search results, and shops.

Supported countries:

  • Americas: Canada (ca), Mexico (mx), and United States (us)
  • Asia: India (in)
  • Europe: France (fr), Germany (de), Italy (it), Spain (es), and United Kingdom (gb)

Supported topics:

Jump to: bestsellers, movers_and_shakers, offers, product, product_and_offers, reviews, search_results, shop

Topic bestsellers

Supported key:

  • id

Supported parameters:

  • max_age (default 10080 = 7 days)
  • max_pages (default 1)

Topic movers_and_shakers

Supported key:

  • id

Supported parameters:

  • max_age (default 10080 = 7 days)
  • max_pages (default 1)

Topic offers

Supported key:

  • id

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)
  • condition (default any)

Topic product

Supported key:

  • id

Supported parameters:

  • max_age (default 43200 = 30 days)

Topic product_and_offers

Supported keys:

  • id
  • gtin
  • asin
  • term

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)
  • condition (default new)

Topic reviews

Supported key:

  • id

Supported parameters:

  • max_age (default 10080 = 7 days)
  • max_pages (default 1)
  • sort_by (default relevance_descending)

Topic search_results

Supported keys:

  • gtin
  • asin
  • term

Supported parameters:

  • max_age (default 43200 = 30 days)
  • max_pages (default 1)
  • category_id (omitted by default)
  • sort_by (default relevance_descending)
  • min_price (omitted by default)
  • max_price (omitted by default)

Topic shop

Supported key:

  • id

Supported parameters:

  • max_age (default about 1 year)
Suggest Edits

Billiger

 

We currently provide data on billiger.de (billiger) for 1 country. The data includes products, search results, shops, and top lists.

Supported countries:

  • Europe: Germany (de)

Supported topics:

Jump to: product, product_and_offers, search_results, shop, top_list

Topic product

Supported key:

  • id

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)
  • sort_by (default price_ascending)

Topic product_and_offers

Supported keys:

  • id
  • asin
  • gtin
  • mpn
  • pzn
  • term

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)
  • sort_by (default price_ascending)

Topic search_results

Supported keys:

  • asin
  • gtin
  • mpn
  • pzn
  • term

Supported parameters:

  • max_age (default 43200 = 30 days)
  • max_pages (default 1)
  • category_id (omitted by default)
  • sort_by (default relevance_descending)
  • min_price (omitted by default)
  • max_price (omitted by default)

Topic shop

Supported key:

  • id

Supported parameters:

  • max_age (default about 1 year)

Topic top_list

Supported key:

  • id

Supported parameters:

  • max_age (default 10080 = 7 days)
  • max_pages (default 1)
Suggest Edits

Cenowarka

 

We currently provide data on Cenowarka (cenowarka) for 1 country. The data includes offers, products, search results, and shops.

Supported countries:

  • Europe: Poland (pl)

Supported topics:

Jump to: offers, product, product_and_offers, search_results, shop

Topic offers

Supported key:

  • id

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)

Topic product

Supported key:

  • id

Supported parameters:

  • max_age (default 38880)

Topic product_and_offers

Supported keys:

  • id
  • term
  • gtin

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)

Topic search_results

Supported keys:

  • term
  • gtin

Supported parameters:

  • max_age (default 38880)
  • max_pages (default 1)

Topic shop

Supported key:

  • id

Supported parameters:

  • max_age (default about 1 year)
Suggest Edits

eBay

 

We currently provide data on eBay (ebay) for 18 countries. The data includes search results.

Supported countries:

  • Americas: Canada (ca) and United States (us)
  • Asia: India (in), Malaysia (my), Philippines (ph), and Singapore (sg)
  • Europe: Austria (at), Belgium (be), France (fr), Germany (de), Ireland (ie), Italy (it), Netherlands (nl), Poland (pl), Spain (es), Switzerland (ch), and United Kingdom (gb)
  • Oceania: Australia (au)

Supported topics:

Jump to: product_and_offers, search_results

Topic product_and_offers

Supported keys:

  • term
  • gtin

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)
  • sort_by (default ranking_descending)

Topic search_results

Supported keys:

  • term
  • gtin

Supported parameters:

  • max_age (default 38880)
  • max_pages (default 1)
  • sort_by (default ranking_descending)
Suggest Edits

Geizhals

 

We currently provide data on Geizhals (geizhals) for 2 countries. The data includes offers, products, search results, and shops.

Supported countries:

  • Europe: Austria (at) and Germany (de)

Supported topics:

Jump to: offers, product, product_and_offers, search_results, shop

Topic offers

Supported key:

  • id

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)

Topic product

Supported key:

  • id

Supported parameters:

  • max_age (default 38880)

Topic product_and_offers

Supported keys:

  • id
  • term
  • gtin

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)

Topic search_results

Supported keys:

  • term
  • gtin

Supported parameters:

  • max_age (default 38880)
  • max_pages (default 1)

Topic shop

Supported key:

  • id

Supported parameters:

  • max_age (default about 1 year)
Suggest Edits

Google Shopping

 

We currently provide data on Google Shopping (google_shopping) for 23 countries. The data includes offers, products, product specs, and search results.

Supported countries:

  • Americas: Brazil (br), Canada (ca), Mexico (mx), and United States (us)
  • Asia: India (in), Japan (jp), and Turkey (tr)
  • Europe: Austria (at), Belgium (be), Czech Republic (cz), Denmark (dk), France (fr), Germany (de), Italy (it), Netherlands (nl), Norway (no), Poland (pl), Russian Federation (ru), Spain (es), Sweden (se), Switzerland (ch), and United Kingdom (gb)
  • Oceania: Australia (au)

Supported topics:

Jump to: offers, product, product_and_offers, product_specs, search_results

Topic offers

Supported key:

  • id

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)
  • sort_by (default ranking_descending)
  • condition (default any)
  • shipping (default any)

Topic product

Supported key:

  • id

Supported parameters:

  • max_age (default 43200 = 30 days)

Topic product_and_offers

Supported keys:

  • id
  • term
  • gtin

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)
  • sort_by (default ranking_descending)
  • condition (default any)
  • shipping (default any)

Topic product_specs

Supported key:

  • id

Supported parameters:

  • max_age (default 43200 = 30 days)

Topic search_results

Supported keys:

  • term
  • gtin

Supported parameters:

  • max_age (default 43200 = 30 days)
  • max_pages (default 1)
  • sort_by (default ranking_descending)
  • condition (default any)
  • min_price (omitted by default)
  • max_price (omitted by default)
Suggest Edits

Idealo

 

Currently in beta.

This source is currently in beta. It may still change or contain bugs.

Source available on request

This source can be added to your account by our support team on request.

We currently provide data on Idealo (idealo) for 6 countries. The data includes offers, price histories, products, search results, shops, top lists, and variants.

Supported countries:

  • Europe: Austria (at), France (fr), Germany (de), Italy (it), Spain (es), and United Kingdom (gb)

Supported topics:

Jump to: offers, price_history, product, product_and_offers, search_results, shop, top_list, variants

Topic offers

Supported key:

  • id

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)

Topic price_history

Supported key:

  • id

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • period (default 3M)

Topic product

Supported key:

  • id

Supported parameters:

  • max_age (default 43200 = 30 days)

Topic product_and_offers

Supported keys:

  • id
  • term
  • gtin

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)

Topic search_results

Supported keys:

  • term
  • gtin

Supported parameters:

  • max_age (default 43200 = 30 days)
  • max_pages (default 1)
  • sort_by (default relevance_descending)

Topic shop

Supported key:

  • id

Supported parameters:

  • max_age (default about 1 year)

Topic top_list

Supported key:

  • id

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)

Topic variants

Supported key:

  • id

Supported parameters:

  • max_age (default 1200 = 20 hours)
Suggest Edits

Medizinfuchs

 

We currently provide data on Medizinfuchs (medizinfuchs) for 1 country. The data includes offers, products, search results, and shops.

Supported countries:

  • Europe: Germany (de)

Supported topics:

Jump to: offers, product, product_and_offers, search_results, shop

Topic offers

Supported key:

  • id

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)

Topic product

Supported key:

  • id

Supported parameters:

  • max_age (default 38880)

Topic product_and_offers

Supported keys:

  • term
  • pzn
  • id

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)

Topic search_results

Supported keys:

  • term
  • pzn

Supported parameters:

  • max_age (default 38880)
  • max_pages (default 1)
  • sort_by (default relevance_descending)

Topic shop

Supported key:

  • id

Supported parameters:

  • max_age (default about 1 year)
Suggest Edits

Pricerunner

 

We currently provide data on Pricerunner (pricerunner) for 4 countries. The data includes offers, products, search results, and shops.

Supported countries:

  • Europe: Denmark (dk), Germany (de), Sweden (se), and United Kingdom (gb)

Supported topics:

Jump to: offers, product, product_and_offers, search_results, shop

Topic offers

Supported key:

  • id

Supported parameters:

  • max_age (default 1200 = 20 hours)

Topic product

Supported key:

  • id

Supported parameters:

  • max_age (default 38880)

Topic product_and_offers

Supported keys:

  • id
  • term
  • gtin

Supported parameters:

  • max_age (default 1200 = 20 hours)

Topic search_results

Supported keys:

  • term
  • gtin

Supported parameters:

  • max_age (default 38880)
  • max_pages (default 1)
  • sort_by (default availability_descending)

Topic shop

Supported key:

  • id

Supported parameters:

  • max_age (default about 1 year)
Suggest Edits

Skinflint

 

We currently provide data on Skinflint (skinflint) for 1 country. The data includes offers, products, search results, and shops.

Supported countries:

  • Europe: United Kingdom (gb)

Supported topics:

Jump to: offers, product, product_and_offers, search_results, shop

Topic offers

Supported key:

  • id

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)

Topic product

Supported key:

  • id

Supported parameters:

  • max_age (default 38880)

Topic product_and_offers

Supported keys:

  • id
  • term
  • gtin

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)

Topic search_results

Supported keys:

  • term
  • gtin

Supported parameters:

  • max_age (default 38880)
  • max_pages (default 1)

Topic shop

Supported key:

  • id

Supported parameters:

  • max_age (default about 1 year)
Suggest Edits

Test

This source generates fake data for testing. You can use this source free of charge.

 

Free to use

Using this source does not cost any credits. It pretends to cost credits though, so you can test tracking credits as well.

We currently provide data on Test (test) for 8 countries. The data includes offers, products, search results, and shops.

Supported countries:

  • Americas: Canada (ca) and United States (us)
  • Asia: India (in)
  • Europe: France (fr), Germany (de), Italy (it), Spain (es), and United Kingdom (gb)

Supported topics:

Jump to: offers, product, product_and_offers, search_results, shop

Topic offers

Supported key:

  • id

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)
  • condition (default new)
  • sort_by (default price)

Topic product

Supported key:

  • id

Supported parameters:

  • max_age (default 43200 = 30 days)

Topic product_and_offers

Supported keys:

  • id
  • term
  • gtin

Supported parameters:

  • max_age (default 1200 = 20 hours)
  • max_pages (default 1)
  • condition (default new)
  • sort_by (default price)

Topic search_results

Supported keys:

  • term
  • gtin
  • asin

Supported parameters:

  • max_pages (default 1)
  • max_age (default 1200 = 20 hours)

Topic shop

Supported key:

  • id

Supported parameters:

  • max_age (default about 1 year)
Suggest Edits

Technical migration guide

Your fastest way from version 1 to version 2

 

Use the test datasource

To make things easier for you, we have added a test data source that behaves like the amazon data source, but only pretends to cost you credits.

New endpoints

While the three-step process (create a job, poll its status, download the results) is still the same, there are three new versioned endpoints for this process:

  1. /v2/jobs
  2. /v2/jobs/:job_id
  3. /v2/jobs/:job_id/download

New parameter topic

Version 2 is all about flexibility. While you could only request products and the offers attached to them in version 1, this is now only one of the many kinds of information Price API can collect for you. In addition, we supply search results, reviews, bestsellers and more. You can choose the kind of information to collect with the new mandatory parameter topic.

To make things easier for customers migrating from version 1, we support a topic product_and_offers that behaves very similar to what you are used to from version 1.

New key names id and term

In version 2, the key source_id has been renamed to just id and keyword has been renamed to term.

New JSON and XML response structure

We took the time to tidy up our response structures with the goal to make it more readable and intuitive for you.

At the root level, the response will only have a few attributes concerning the job:

{
  "job_id": "5a3008a0e4dd586e77a2b89a",
  "status": "finished",
  "free_credits": 1,
  "paid_credits": 0,
  "results": [ ... ]
}
 
<?xml version="1.0" encoding="UTF-8"?>
<hash>
  <job-id>5a3005360ef4ae2d61005716</job-id>
  <status type="symbol">finished</status>
  <free-credits type="integer">1</free-credits>
  <paid-credits type="integer">0</paid-credits>
  <results type="array"><!-- ... --></results>
<hash>

The results attribute contains an array of objects, one entry for each value requested in the job. They each hold four to five attributes:

  • query states your request
  • success indicates true exactly when we successfully collected data
  • optionally reason if it was not successful
  • metadata including information on how the job was processed
  • and content holding the data collected

Here's an example:

"results": [
  {
    "query": {
      "source": "google_shopping",
      "country": "de",
      "topic": "offers",
      "key": "id",
      "value": "2680289002714187668",
      "max_pages": 1,
      "max_age": 1200,
      "sort_by": "ranking_descending",
      "condition": "any",
      "shipping": "any"
    },
    "success": true,
    "metadata": {
      "from_cache": false,
      "page_count_delivered": 1,
      "page_count_from_cache": 0,
      "page_count_live": 1,
      "request_count": 1,
      "updated_at": "2017-12-12T16:49:40Z"
    },
    "content": { ... }
  },
  // More results ...
]
 
<results type="array">
  <result>
    <query>
      <source>google_shopping</source>
      <country>de</country>
      <topic>offers</topic>
      <key>id</key>
      <value>2680289002714187668</value>
      <max-pages type="integer">1</max-pages>
      <max-age type="integer">1200</max-age>
      <sort-by>ranking_descending</sort-by>
      <condition>any</condition>
      <shipping>any</shipping>
    </query>
    <success type="boolean">true</success>
    <metadata>
      <from-cache type="boolean">false</from-cache>
      <page-count-delivered type="integer">1</page-count-delivered>
      <page-count-from-cache type="integer">0</page-count-from-cache>
      <page-count-live type="integer">1</page-count-live>
      <request-count type="integer">27</request-count>
      <updated-at type="dateTime">2017-12-12T16:36:13Z</updated-at>
    </metadata>
    <content><!-- ... --></content>
  </result>
  <!-- More results -->
</results>

The content attribute can hold an array for lists of things or an object or null. Here's an example:

"content": {
  "total_offer_count": 63,
  "offers": [
    {
      "price": "349.0",
      "shipping_costs": "0.0",
      "price_with_shipping": "349.0",
      "currency": "EUR",
      "shop_name": "some-example-shop.com",
      "shop_id": "7935878264",
      "shop_review_count": 667,
      "shop_review_rating": 94,
      // ...
    },
    // More offers ...
  ]
}
 
<content>
  <total-offers-count type="integer">63</total-offers-count>
  <offers type="array">
    <offer>
      <price>349.0</price>
      <price-with-shipping>349.0</price-with-shipping>
      <shipping-costs>0.0</shipping-costs>
      <currency>EUR</currency>
      <shop-name>saturn.de</shop-name>
      <shop-matching-id>t3.media01.eu</shop-matching-id>
      <shop-review-count type="integer">667</shop-review-count>
      <shop-review-rating type="integer">94</shop-review-rating>
	    <!-- ... -->
    </offer>
    <!-- More offers -->
  </offers>
</content>

Success

In version 2, we return "success": true exactly then, when we could access the data source and collect data from it.

We also return true now when we successfully searched for a product and it was not present on the source. In version 1, this was reported as "success": false, "reason": "not found". This will come with a content value of null (if the content is usually represented as an object) or empty array [] (if the content is usually represented as an array).

Use the timeout parameter

For some use cases, you would prefer to receive partial data instead of waiting longer. To support this, we introduced a new parameter that allows you to determine after how many minutes a job's data collection should end.

A job that runs in a timeout will change to status finished and can then be downloaded and processed like any other job. It will include some results marked as "success": false, "reason": "timeout".

Default timeout

If you don't specify otherwise, we have set a default of 1,440 minutes (24 hours).

Did we miss anything?

Please get in contact so we can help you out and so that we can improve our documentation.