Outprice API documentation

{
  "query": "string",
  "venture": "pk",
  "groups": [
    {
      "title": "string",
      "seller_count": 1,
      "offer_count": 1,
      "in_stock_count": 1,
      "currency": "",
      "lowest": 1.1,
      "median": 1.1,
      "highest": 1.1,
      "offers": [
        {
          "title": "string",
          "url": "string",
          "price": 1.1,
          "shipping": 1.1,
          "original_price": 1.1,
          "discount_pct": 1.1,
          "currency": "",
          "in_stock": true,
          "seller_name": "string",
          "seller_id": "string",
          "marketplace": "",
          "listing_id": "string",
          "is_mine": false,
          "rating": 1.1,
          "review_count": 1,
          "image_url": "string",
          "confidence": 0.75
        }
      ],
      "uncertain": [
        {
          "title": "string",
          "url": "string",
          "price": 1.1,
          "shipping": 1.1,
          "original_price": 1.1,
          "discount_pct": 1.1,
          "currency": "",
          "in_stock": true,
          "seller_name": "string",
          "seller_id": "string",
          "marketplace": "",
          "listing_id": "string",
          "is_mine": false,
          "rating": 1.1,
          "review_count": 1,
          "image_url": "string",
          "confidence": 0.75
        }
      ],
      "your_position": {
        "own_price": 1.1,
        "of": 1,
        "vs_median": 1.1,
        "vs_median_pct": 1.1,
        "vs_lowest": 1.1,
        "is_cheapest": true,
        "undercut_by": 1.1,
        "rank": 1
      },
      "delivery_note": "string"
    }
  ],
  "total_offers": 0,
  "sources_ok": [
    "string"
  ],
  "sources_failed": [
    {}
  ],
  "set_aside": 0,
  "strict": true
}

Authentication

X-API-Keystring

Your Outprice API key (starts with pw_).

Query parameters

qstringRequired2-120 characters

What you sell — a product name, model, or brand

venturestring or nullOptional<=8 characters

Country to search in. Defaults to the account's own.

own_pricedouble or nullOptional

Your price, to see where you sit. Optional.

limitintegerOptional1-40Defaults to 40

strictbooleanOptionalDefaults to true

Only show listings that mention every search word. Set false to see what was set aside — useful for category searches like ‘smartphone’, whose titles rarely say it.

Response

Successful Response

querystring

venturestringOptionalDefaults to pk

groupslist of objectsOptional

total_offersintegerOptionalDefaults to 0

sources_oklist of stringsOptional

sources_failedlist of maps from strings to anyOptional

set_asideintegerOptionalDefaults to 0

strictbooleanOptionalDefaults to true

Errors

422

Unprocessable Entity Error