The PricePlow API (v1)

Welcome to the PricePlow API. This API was created for developers who wish to monetize their health/fitness/nutrition apps and sites using PricePlow’s price comparisons.

For a list of features and benefits in plain English, see our main PricePlow API page.

Target Audience

What’s this area on the right side?

When you scroll down or click the left sidebar links to view our API endpoints, we will post example calls and responses over here.

This document assumes technical proficiency. If you do not know how to program, please see the examples below in the plugins section.

Plugin Requests

If you wish to develop a new app or plugin for a new target, contact us at [email protected] for assistance.

Plugins

WordPress Plugin

The PricePlow WordPress Plugin uses this API. See the source code at github.com/clutchwave/priceplow-wp-plugin - both the PHP and JavaScript code use the API.


Technical Overview

Base API Endpoint: https://api.priceplow.com/v1

JSON is returned in all API responses, including errors.

This API, and the entire PricePlow site, are https only.

Authentication

All API requests require an API key to be included via the api_key query string parameter. The only exception is that registering for an API key does not require an API key.

Some sensitive requests also require an API secret to be included via the api_secret query string parameter. It’s highly advised that these sensitive requests are performed from a server that you control. You should never expose your API secret to the public.


Resources to Get Started

API Client

https://api.priceplow.com/v1/client

Register for an API key

Example Request:

$ curl https://api.priceplow.com/v1/client/register/wordpress \
   -X POST \
   -d domain="example.com" \

Note: The following code is documented towards our WordPress plugin, but it will work for anyone requesting an API Key.

Request

POST https://api.priceplow.com/v1/client/register/wordpress

Example Response:

{
    "api_key": "81e3c22468aa4631a9398a12d5b21234",
    "api_secret": "0bb82dd843334f19ae27327694c61234",
    "incoming_campaign_id": 1
}
Arguments
domain: string optional The domain the plugin is installed on.
Attributes
api_key: string The API key that was created for the plugin.
api_secret: string The API secret that was created for the plugin.
incoming_campaign_id: integer The incoming campaign id that the plugin should append to outgoing product links via the ic query string parameter. For example https://www.pricpelow.com/out/249138?ic=8.

List affiliate campaign codes

Example Request:

$ curl https://api.priceplow.com/v1/client/affiliate_campaigns?api_key=<key>&api_secret=<secret>

Request

GET https://api.priceplow.com/v1/client/affiliate_campaigns

Authentication: Requires API secret.

Response

Returns an array of the client’s current affiliate campaign codes for each affiliate network that PricePlow supports.

Example Response:

[
    {
        "campaign_code": "HB90254",
        "affiliate_network_id": 1,
        "affiliate_network_name": "Commission Junction"
    },
    {
        "campaign_code": "ABCD1234",
        "affiliate_network_id": 2,
        "affiliate_network_name": "AllStarHealth"
    },
    {
        "campaign_code": "1234",
        "affiliate_network_id": 3,
        "affiliate_network_name": "TigerFitness"
    },
    {
        "campaign_code": null,
        "affiliate_network_id": 4,
        "affiliate_network_name": "Netrition"
    },
    {
        "campaign_code": null,
        "affiliate_network_id": 5,
        "affiliate_network_name": "A1Supplements"
    },
    {...},
    {...}
]
Attributes
affiliate_network_id: integer The affiliate network identifier.
affiliate_network_name: integer The name of the affiliate network.
campaign_code: string The client’s campaign code for the affiliate network. Defaults to null if the client has not yet provided a campaign code for the affiliate network.

Save affiliate campaign codes

Example Request:

$ curl https://api.priceplow.com/v1/client/affiliate_campaigns?api_key=<key>&api_secret=<secret> \
    -X PUT -H "Content-Type: application/json" -d '{"affiliate_campaigns": [{"affiliate_network_id": 1, "campaign_code": "ABC"}, {"affiliate_network_id": 2, "campaign_code": "12345"}]}'

Request

POST https://api.priceplow.com/v1/client/affiliate_campaigns?api_key=<key>&api_secret=<secret>

Authentication: Requires API secret.

Arguments
affiliate_network_id: integer The affiliate network identifier.
campaign_code: string Your campaign code for the affiliate network / site.

The above arguments must be placed in a JSON-formatted list. See the example to the right.

Response

Returns an array containing dictionaries for each affiliate network that PricePlow supports. Each dictionary contains the client’s campaign code for the affiliate network.

Example Response:

[
    {
        "campaign_code": "CODE1",
        "affiliate_network_id": 1,
        "affiliate_network_name": "Commission Junction"
    },
    {
        "campaign_code": "CODE2",
        "affiliate_network_id": 2,
        "affiliate_network_name": "AllStarHealth"
    },
    {
        "campaign_code": "CODE3",
        "affiliate_network_id": 3,
        "affiliate_network_name": "TigerFitness"
    },
    {
        "campaign_code": null,
        "affiliate_network_id": 4,
        "affiliate_network_name": "Netrition"
    },
    {
        "campaign_code": null,
        "affiliate_network_id": 5,
        "affiliate_network_name": "A1Supplements"
    },
    {...},
    {...}
]
Attributes
affiliate_network_id: integer The affiliate network identifier.
affiliate_network_name: integer The name of the affiliate network.
campaign_code: string The client’s campaign code for the affiliate network. Defaults to null if the client has not yet provided a campaign code for the affiliate network.

View API client info (incoming_campaign)

Request

GET https://api.priceplow.com/v1/client/info?api_key=<key>&api_secret=<secret>

Authentication: Requires API secret.

Example Request:
$ curl https://api.priceplow.com/v1/client/info?api_key=<key>&api_secret=<secret>

Response

Example Response:
{
    "campaign_code_rotate_percent": "0.70000",
    "incoming_campaign_id": 11
}
Attributes
campaign_code_rotate_percent: string Decimal percent that specifies how often to use the API client’s campaign codes in product affiliate links. Defaults to 0.70 (70%).
incoming_campaign_id: integer The incoming campaign id that the plugin should append to outgoing product links via the ic query string parameter. For example https://www.pricpelow.com/out/249138?ic=8.

Brands

Brand object

Example Object:

{
    "id": 584,
    "name": "MTS Nutrition",
    "url": "https://www.priceplow.com/mts-nutrition",
    "thumbnail_image_url": "https://www.priceplow.com/static/images/brands/mts-nutrition-small.jpg"
}

Endpoint:

https://api.priceplow.com/v1/brands

Attributes
id: integer Brand identifier.
name: string Brand name.
url: string PricePlow URL for the brand.
thumbnail_image_url: string If the brand has no thumbnail image, then this will be an empty string "".

List available brands

Example Request:

$ curl https://api.priceplow.com/v1/brands?api_key=<key>

Example Response:

[
    {
        "id": 2048,
        "name": "the Vitamin Shoppe",
        "thumbnail_image_url": "",
        "url": "https://www.priceplow.com/the-vitamin-shoppe"
    },
    {
        "id": 1,
        "name": "4 Dimension Nutrition",
        "thumbnail_image_url": "",
        "url": "https://www.priceplow.com/4-dimension-nutrition"
    },
    {
        "id": 2,
        "name": "4Ever Fit",
        "thumbnail_image_url": "",
        "url": "https://www.priceplow.com/4ever-fit"
    },
    {
        "id": 3,
        "name": "6 Pack Fitness",
        "thumbnail_image_url": "",
        "url": "https://www.priceplow.com/6-pack-fitness"
    },
    {...},
    {...}
]

List all brands that have at least one product currently in stock.

Request

GET https://api.priceplow.com/v1/brands

Response

Returns an array of the Brand objects.

List available products for a brand

Example Request (showing 4 products):

$ curl https://api.priceplow.com/v1/brands/150/products?api_key=<key>&count=4

Example Response:

[
    {
        "brand": {
            "id": 150,
            "name": "Giant Sports",
            "url": "https://www.priceplow.com/giant-sports"
        },
        "id": 29653,
        "large_image_url": "https://www.priceplow.com/static/images/products/giant-sports-dexamine-large.jpg",
        "lowest_prices": [
            {
                "price": "29.99",
                "size": "60 Capsules",
                "store": "Vitamin Shoppe",
                "url": "https://www.priceplow.com/out/giant-sports/dexamine?size=60"
            }
        ],
        "name": "Dexamine",
        "thumbnail_image_url": "https://www.priceplow.com/static/images/products/giant-sports-dexamine-small.jpg",
        "url": "https://www.priceplow.com/giant-sports/dexamine"
    },
    {
        "brand": {
            "id": 150,
            "name": "Giant Sports",
            "url": "https://www.priceplow.com/giant-sports"
        },
        "id": 29655,
        "large_image_url": "https://www.priceplow.com/static/images/products/giant-sports-metabolic-bioshock-large.jpg",
        "lowest_prices": [
            {
                "price": "36.99",
                "size": "40 Servings",
                "store": "Vitamin Shoppe",
                "url": "https://www.priceplow.com/out/giant-sports/metabolic-bioshock?size=40"
            }
        ],
        "name": "Metabolic BioShock",
        "thumbnail_image_url": "https://www.priceplow.com/static/images/products/giant-sports-metabolic-bioshock-small.jpg",
        "url": "https://www.priceplow.com/giant-sports/metabolic-bioshock"
    },
    {...},
    {...}

Request

GET https://api.priceplow.com/v1/brands/<brand_id>/products

Response

Returns an array of up to count Product objects.

Example Request (Optimum Nutrition):

$ curl https://api.priceplow.com/v1/brands/292/products/popular?api_key=<key>

Example Response:

[
    {
        "brand": {
            "id": 292,
            "name": "Optimum Nutrition",
            "thumbnail_image_url": "",
            "url": "https://www.priceplow.com/optimum-nutrition"
        },
        "category": {
            "id": 8,
            "name": "Micellar Casein Protein",
            "url": "https://www.priceplow.com/micellar-casein-protein"
        },
        "id": 43,
        "large_image_url": "https://www.priceplow.com/static/images/products/optimum-nutrition-gold-standard-100-casein-large.jpg",
        "lowest_prices": [
            {
                "flavor": "Banana Cream",
                "price": "28.99",
                "size": "2 Lbs.",
                "url": "https://www.priceplow.com/out/optimum-nutrition/gold-standard-100-casein?size=2"
            },
            {
                "flavor": "Chocolate Cake Batter",
                "price": "46.95",
                "size": "4 Lbs.",
                "url": "https://www.priceplow.com/out/optimum-nutrition/gold-standard-100-casein?size=4"
            }
        ],
        "name": "Gold Standard 100% Casein",
        "thumbnail_image_url": "https://www.priceplow.com/static/images/products/optimum-nutrition-gold-standard-100-casein-small.jpg",
        "url": "https://www.priceplow.com/optimum-nutrition/gold-standard-100-casein"
    },
    {
        "brand": {
            "id": 292,
            "name": "Optimum Nutrition",
            "thumbnail_image_url": "",
            "url": "https://www.priceplow.com/optimum-nutrition"
        },
        "category": {
            "id": 11,
            "name": "Protein Powder",
            "url": "https://www.priceplow.com/protein-powder"
        },
        "id": 116,
        "large_image_url": "https://www.priceplow.com/static/images/products/optimum-nutrition-complete-protein-diet-large.jpg",
        "lowest_prices": [
            {
                "flavor": "Double Rich Chocolate",
                "price": "53.95",
                "size": "40 Servings",
                "url": "https://www.priceplow.com/out/optimum-nutrition/complete-protein-diet?size=40"
            }
        ],
        "name": "Complete Protein Diet",
        "thumbnail_image_url": "https://www.priceplow.com/static/images/products/optimum-nutrition-complete-protein-diet-small.jpg",
        "url": "https://www.priceplow.com/optimum-nutrition/complete-protein-diet"
    },
    {...},
    {...}
]

Some brands have rather large listings, and sometimes you just want to “randomly” show some of their better products for the sake of diversity.

This is useful for public widgets such as in the WordPress plugin.

Request

GET https://api.priceplow.com/v1/brands/<brand_id>/products/popular

Arguments
count: integer optional Specifies the number of products to show. Default: 10. Maximum: 25.

Response

Returns an array of up to count Product objects.


Categories

Category object

{
    "id": 2,
    "name": "Protein",
    "url": "https://www.priceplow.com/protein"
}

https://api.priceplow.com/v1/categories

Category Object

Attributes
id: integer Unique category identifier
name: string The category’s name.
url: string The category’s PricePlow URL.

Category Tree

See the response code to the right for an example of a category tree object.

List categories

Example Request:

$ curl https://api.priceplow.com/v1/categories?api_key=<key>

Example Response (truncated weight loss category tree)

[
    {
        "children": [{
            "children": [{
                "children": [],
                "id": 432,
                "name": "Fat Burners for Women",
                "url": "https://www.priceplow.com/fat-burners-for-women"
            }, {
                "children": [],
                "id": 876,
                "name": "Fat Burning Drinks",
                "url": "https://www.priceplow.com/fat-burning-drinks"
            }, {
                "children": [{
                    "children": [],
                    "id": 842,
                    "name": "Chlorogenic Acid",
                    "url": "https://www.priceplow.com/chlorogenic-acid"
                }],
                "id": 430,
                "name": "Green Coffee Bean Extract",
                "url": "https://www.priceplow.com/green-coffee-bean-extract"
            }, {
                "children": [],
                "id": 905,
                "name": "Green Tea Extract",
                "url": "https://www.priceplow.com/green-tea-extract"
            }, {
                "children": [{
                    "children": [],
                    "id": 293,
                    "name": "African Mango",
                    "url": "https://www.priceplow.com/african-mango"
                }, {
                    "children": [],
                    "id": 878,
                    "name": "Forskolin",
                    "url": "https://www.priceplow.com/forskolin"
                },
                {...}],
                    "id": 861,
                    "name": "Garcinia Cambogia",
                    "url": "https://www.priceplow.com/garcinia-cambogia"
                }],
                "id": 817,
                "name": "Stimulant Free Fat Burners",
                "url": "https://www.priceplow.com/stimulant-free-fat-burners"
            }, {
                "children": [],
                "id": 71,
                "name": "Synephrine",
                "url": "https://www.priceplow.com/synephrine"
            }, {
                "children": [{
                    "children": [],
                    "id": 847,
                    "name": "Yohimbine",
                    "url": "https://www.priceplow.com/yohimbine"
                }],
                "id": 72,
                "name": "Yohimbe",
                "url": "https://www.priceplow.com/yohimbe"
            }, {
                "children": [],
                "id": 1066,
                "name": "Ephedra",
                "url": "https://www.priceplow.com/ephedra"
            }],
            "id": 90,
            "name": "Fat Burners",
            "url": "https://www.priceplow.com/fat-burners"
        }, {
            "children": [],
            "id": 334,
            "name": "7-KETO",
            "url": "https://www.priceplow.com/7-keto"
        }, {
            "children": [{
                "children": [],
                "id": 105,
                "name": "Thyroid Support",
                "url": "https://www.priceplow.com/thyroid-support"
            }],
            "id": 960,
            "name": "Adrenal Fatigue",
            "url": "https://www.priceplow.com/adrenal-fatigue"
        }, {
            "children": [],
            "id": 104,
            "name": "Appetite Suppressant",
            "url": "https://www.priceplow.com/appetite-suppressant"
        }, {
            "children": [{
                "children": [{
                    "children": [],
                    "id": 987,
                    "name": "White Kidney Bean Extract",
                    "url": "https://www.priceplow.com/white-kidney-bean-extract"
                }],
                "id": 429,
                "name": "Carb Blockers",
                "url": "https://www.priceplow.com/carb-blockers"
            }, {
                "children": [{
                    "children": [],
                    "id": 1055,
                    "name": "Glucomannan",
                    "url": "https://www.priceplow.com/glucomannan"
                }],
                "id": 803,
                "name": "Glucose Disposal Agents",
                "url": "https://www.priceplow.com/glucose-disposal-agents"
            }, {
                "children": [],
                "id": 853,
                "name": "Ursolic Acid",
                "url": "https://www.priceplow.com/ursolic-acid"
            }],
            "id": 93,
            "name": "Blood Sugar Supplements",
            "url": "https://www.priceplow.com/blood-sugar-supplements"
        },
        {...},
        {...}],
        "id": 89,
        "name": "Weight Loss",
        "url": "https://www.priceplow.com/weight-loss"
    },
    {...},
    {...}
]

Request

GET https://api.priceplow.com/v1/categories

Response

Returns an array of Category objects with an additional children attribute. The children attribute is itself a CategoryTree (the data structure is recursive). The first level consists of the root categories.

Example Request:

$ curl https://api.priceplow.com/v1/categories/2/products/popular?api_key=<key>

Example Response:

[
    {
        "brand": {
            "id": 15,
            "name": "AllMax Nutrition",
            "thumbnail_image_url": "",
            "url": "https://www.priceplow.com/allmax-nutrition"
        },
        "category": {
            "id": 4,
            "name": "Whey Protein Isolate",
            "url": "https://www.priceplow.com/whey-protein-isolate"
        },
        "id": 3833,
        "large_image_url": "https://www.priceplow.com/static/images/products/allmax-nutrition-isofemme-large.jpg",
        "lowest_prices": [
            {
                "flavor": "Chocolate Temptation",
                "price": "19.99",
                "size": "434 Grams",
                "url": "https://www.priceplow.com/out/allmax-nutrition/isofemme?size=434"
            }
        ],
        "name": "ISOfemme",
        "thumbnail_image_url": "https://www.priceplow.com/static/images/products/allmax-nutrition-isofemme-small.jpg",
        "url": "https://www.priceplow.com/allmax-nutrition/isofemme"
    },
    {
        "brand": {
            "id": 15,
            "name": "AllMax Nutrition",
            "thumbnail_image_url": "",
            "url": "https://www.priceplow.com/allmax-nutrition"
        },
        "category": {
            "id": 15,
            "name": "Weight Gainers",
            "url": "https://www.priceplow.com/weight-gainers"
        },
        "id": 3781,
        "large_image_url": "https://www.priceplow.com/static/images/products/allmax-nutrition-quickmass-loaded-large.jpg",
        "lowest_prices": [
            {
                "flavor": "Strawberry Banana",
                "price": "63.00",
                "size": "10 Lbs.",
                "url": "https://www.priceplow.com/out/allmax-nutrition/quickmass-loaded?size=10"
            },
            {
                "flavor": "Chocolate",
                "price": "44.99",
                "size": "6 Lbs.",
                "url": "https://www.priceplow.com/out/allmax-nutrition/quickmass-loaded?size=6"
            },
            {
                "flavor": "Chocolate",
                "price": "26.99",
                "size": "3.3 Lbs.",
                "url": "https://www.priceplow.com/out/allmax-nutrition/quickmass-loaded?size=3.3"
            }
        ],
        "name": "QuickMass Loaded",
        "thumbnail_image_url": "https://www.priceplow.com/static/images/products/allmax-nutrition-quickmass-loaded-small.jpg",
        "url": "https://www.priceplow.com/allmax-nutrition/quickmass-loaded"
    },
    {...},
    {...}
]

Request

GET https://api.priceplow.com/v1/categories/<category_id>/products/popular

Arguments
count: integer optional Specifies the number of products to show. Default: 10. Maximum: 25.

Response

Returns an array of up to count Product objects.


Products

API Endpoint:

https://api.priceplow.com/v1/products

Retrieve store prices for each product size and flavor variation.

The object maps each product size to a list of stores that carry the product size. Each store is a list of objects with the following attributes:

Attributes
flavor: string Product flavor. If the product does not have a flavor, then this will be an empty string "".
price: string The store’s price for this product variation as a decimal string. The currency is USD.
store: string The store’s name.
url: string Outgoing URL to the store’s product page for this product variation.

StorePrices Object

StorePrices object (requires full access to StorePrices) (truncated)

{
    "2 Lbs.": [
        [
            {
                "flavor": "Chocolate Truffle",
                "price": "27.62",
                "store": "VitaCost.com",
                "url": "https://www.priceplow.com/out/315628"
            },
            {
                "flavor": "Vanilla Mint Swirl",
                "price": "34.99",
                "store": "VitaCost.com",
                "url": "https://www.priceplow.com/out/315630"
            }
        ],
        [
            {
                "flavor": "Chocolate Truffle",
                "price": "30.99",
                "store": "Paramount Supplements",
                "url": "https://www.priceplow.com/out/800998"
            },
            {
                "flavor": "Red Velvet Cake",
                "price": "30.99",
                "store": "Paramount Supplements",
                "url": "https://www.priceplow.com/out/800999"
            },
        ],
        [
            {
                "flavor": "Chocolate Truffle",
                "price": "32.90",
                "store": "World Class Nutrition",
                "url": "https://www.priceplow.com/out/708381"
            },
            {
                "flavor": "Red Velvet Cake",
                "price": "32.90",
                "store": "World Class Nutrition",
                "url": "https://www.priceplow.com/out/708382"
            }
        ]
    ],
    "4 Lbs.": [
        [
            {
                "flavor": "Strawberry Creamsicle",
                "price": "32.99",
                "store": "Best Price Nutrition",
                "url": "https://www.priceplow.com/out/753817"
            }
        ],
        [
            {
                "flavor": "Chocolate Truffle",
                "price": "39.99",
                "store": "AllStarHealth.com",
                "url": "https://www.priceplow.com/out/807617"
            },
            {
                "flavor": "Strawberry Creamsicle",
                "price": "46.75",
                "store": "AllStarHealth.com",
                "url": "https://www.priceplow.com/out/427962"
            }
        ],
        [
            {
                "flavor": "Chocolate Truffle",
                "price": "46.75",
                "store": "World Class Nutrition",
                "url": "https://www.priceplow.com/out/708385"
            }
        ],
        [ {...} ],[ {...} ]
    ]
}

See the right side for an example StorePrices object (it is truncated), which you will not fully see until you have access to the database.

LowestStorePrices Object

LowestStorePrices Object Example:

[
    {
        "flavor": "Fruit Punch Slam",
        "price": "29.95",
        "size": "50 Servings",
        "url": "https://www.priceplow.com/out/brand/product?size=50"
    },
    {
        "flavor": "Fruit Punch Slam",
        "price": "59.98",
        "size": "150 Servings",
        "url": "https://www.priceplow.com/out/brand/product?size=150"
    },
    {
        "flavor": "Fruit Punch Slam",
        "price": "8.99",
        "size": "10 Packets",
        "url": "https://www.priceplow.com/out/brand/product?size=10"
    }
]

Lowest store price per product size. This is the default product type returned.

Attributes
size: string Product size.
flavor: string Product flavor with the lowest price. If the product does not have a flavor, then this will be an empty string "".
price: string The lowest price for this product size as a decimal string. The currency is USD.
url: string Outgoing URL to the product at the store with the lowest price.

Product object

{
    "id": 16385,
    "name": "Compete",
    "brand": {
        "id": 446,
        "name": "iForce",
        "thumbnail_image_url": "https://www.priceplow.com/static/images/brands/iforce-small.jpg",
        "url": "https://www.priceplow.com/iforce"
    },
    "category": {
        "id": 25,
        "name": "Intra Workout",
        "url": "https://www.priceplow.com/intra-workout"
    },
    "lowest_prices": [
        {
            "flavor": "Fruit Punch Slam",
            "price": "29.95",
            "size": "50 Servings",
            "url": "https://www.priceplow.com/out/iforce/compete?size=50"
        },
        {
            "flavor": "Fruit Punch Slam",
            "price": "59.98",
            "size": "150 Servings",
            "url": "https://www.priceplow.com/out/iforce/compete?size=150"
        },
        {
            "flavor": "Fruit Punch Slam",
            "price": "8.99",
            "size": "10 Packets",
            "url": "https://www.priceplow.com/out/iforce/compete?size=10"
        }
    ],
    "large_image_url": "https://www.priceplow.com/static/images/products/iforce-compete-large.jpg",
    "thumbnail_image_url": "https://www.priceplow.com/static/images/products/iforce-compete-small.jpg",
    "url": "https://www.priceplow.com/iforce/compete"
}
Attributes
id: integer Unique product identifier.
name: string The product’s name.
brand: Brand The product’s brand.
category: Category The product’s category.
lowest_prices: LowestStorePrices Lowest prices for each product size.
prices: StorePrices Store prices for all product size and flavor combinations. This attribute is not always present in a response.
large_image_url: string If the product has no large image, then this will be an empty string "".
thumbnail_image_url: string If the product has no thumbnail image, then this will be an empty string "".
url: string The product’s PricePlow URL.

Example Request:

$ curl https://api.priceplow.com/v1/products/popular?api_key=<key>

Example Response:

[
    {
        "brand": {
            "id": 332,
            "name": "Quest Nutrition",
            "thumbnail_image_url": "",
            "url": "https://beta.priceplow.com/quest-nutrition"
        },
        "category": {
            "id": 12,
            "name": "Protein Bars",
            "url": "https://beta.priceplow.com/protein-bars"
        },
        "id": 9247,
        "large_image_url": "https://www.priceplow.com/static/images/products/quest-nutrition-quest-bars-large.jpg",
        "lowest_prices": [
            {
                "flavor": "Apple Pie",
                "price": "21.99",
                "size": "12 Bars",
                "url": "https://beta.priceplow.com/out/quest-nutrition/quest-bars?size=12"
            },
            {
                "flavor": "Apple Pie",
                "price": "2.09",
                "size": "1 Bar",
                "url": "https://beta.priceplow.com/out/quest-nutrition/quest-bars?size=1"
            },
            {
                "flavor": "Variety - 3 Flavors",
                "price": "80.38",
                "size": "36 Bars",
                "url": "https://beta.priceplow.com/out/quest-nutrition/quest-bars?size=36"
            }
        ],
        "name": "Quest Bars",
        "thumbnail_image_url": "https://www.priceplow.com/static/images/products/quest-nutrition-quest-bars-small.jpg",
        "url": "https://beta.priceplow.com/quest-nutrition/quest-bars"
    },
    {
        "brand": {
            "id": 677,
            "name": "ANS Performance",
            "thumbnail_image_url": "https://www.priceplow.com/static/images/brands/ans-performance-small.jpg",
            "url": "https://beta.priceplow.com/ans-performance"
        },
        "category": {
            "id": 18,
            "name": "Pre Workout Supplements",
            "url": "https://beta.priceplow.com/pre-workout-supplements"
        },
        "id": 16080,
        "large_image_url": "https://www.priceplow.com/static/images/products/ans-performance-ritual-large.jpg",
        "lowest_prices": [
            {
                "flavor": "Candy Green Apple",
                "price": "29.97",
                "size": "45 Servings",
                "url": "https://beta.priceplow.com/out/ans-performance/ritual?size=45"
            }
        ],
        "name": "RITUAL",
        "thumbnail_image_url": "https://www.priceplow.com/static/images/products/ans-performance-ritual-small.jpg",
        "url": "https://beta.priceplow.com/ans-performance/ritual"
    },
    {...},
    {...}
]

For plugin users who wish to randomly show some featured products from the database:

Request

GET https://api.priceplow.com/v1/products/popular

Arguments
count: integer optional Specifies the number of products to show. Default: 10. Maximum: 25.

Response

Returns an array of up to count Product objects.

List newest available products

Example Request:

$ curl https://api.priceplow.com/v1/products/newest?api_key=<key>

Request

GET https://api.priceplow.com/v1/products/newest

Arguments
count: integer optional Specifies the number of products to show. Default: 10. Maximum: 25.

Response

Returns an array of up to count Product objects.

Example Response (Truncated, with access to StorePrices):

[
    {
        "brand": {
            "id": 381,
            "name": "ThermoLife",
            "thumbnail_image_url": "",
            "url": "https://www.priceplow.com/thermolife"
        },
        "category": {
            "id": 959,
            "name": "Digestive Enzymes",
            "url": "https://www.priceplow.com/digestive-enzymes"
        },
        "id": 50975,
        "large_image_url": "https://www.priceplow.com/static/images/products/thermolife-ecdysten-large.jpg",
        "lowest_prices": [
            {
                "flavor": "",
                "price": "25.95",
                "size": "90 Capsules",
                "url": "https://www.priceplow.com/out/thermolife/ecdysten?size=90"
            }
        ],
        "name": "Ecdysten",
        "thumbnail_image_url": "https://www.priceplow.com/static/images/products/thermolife-ecdysten-small.jpg",
        "url": "https://www.priceplow.com/thermolife/ecdysten"
    },
    {
        "brand": {
            "id": 2068,
            "name": "Athletix",
            "thumbnail_image_url": "",
            "url": "https://www.priceplow.com/athletix"
        },
        "category": {
            "id": 18,
            "name": "Pre Workout Supplements",
            "url": "https://www.priceplow.com/pre-workout-supplements"
        },
        "id": 50928,
        "large_image_url": "https://www.priceplow.com/static/images/products/athletix-acute-fx-large.jpg",
        "lowest_prices": [
            {
                "flavor": "",
                "price": "24.99",
                "size": "80 Capsules",
                "url": "https://www.priceplow.com/out/athletix/acute-fx?size=80"
            }
        ],
        "name": "Acute FX",
        "thumbnail_image_url": "https://www.priceplow.com/static/images/products/athletix-acute-fx-small.jpg",
        "url": "https://www.priceplow.com/athletix/acute-fx"
    },
    {...},
    {...}
]

List store prices for a product

Example Request:

$ curl https://api.priceplow.com/v1/products/16419?api_key=<key>

Request

GET https://api.priceplow.com/v1/products/<product_id>

Response

Returns a Product object with StorePrices.

Example Response (without access to StorePrices):

{
    "brand": {
        "id": 446,
        "name": "iForce",
        "thumbnail_image_url": "https://www.priceplow.com/static/images/brands/iforce-small.jpg",
        "url": "https://www.priceplow.com/iforce"
    },
    "category": {
        "id": 11,
        "name": "Protein Powder",
        "url": "https://www.priceplow.com/protein-powder"
    },
    "id": 16419,
    "large_image_url": "https://www.priceplow.com/static/images/products/iforce-protean-large.jpg",
    "lowest_prices": [
        {
            "flavor": "Strawberry Creamsicle",
            "price": "32.99",
            "size": "4 Lbs.",
            "url": "https://www.priceplow.com/out/iforce/protean?size=4"
        },
        {
            "flavor": "Chocolate Truffle",
            "price": "27.62",
            "size": "2 Lbs.",
            "url": "https://www.priceplow.com/out/iforce/protean?size=2"
        }
    ],
    "name": "Protean",
    "thumbnail_image_url": "https://www.priceplow.com/static/images/products/iforce-protean-small.jpg",
    "url": "https://www.priceplow.com/iforce/protean"
}

Example Response (truncated - with access to StorePrices):

{
    "brand": {
        "id": 446,
        "name": "iForce",
        "thumbnail_image_url": "https://www.priceplow.com/static/images/brands/iforce-small.jpg",
        "url": "https://beta.priceplow.com/iforce"
    },
    "category": {
        "id": 11,
        "name": "Protein Powder",
        "url": "https://beta.priceplow.com/protein-powder"
    },
    "id": 16419,
    "large_image_url": "https://www.priceplow.com/static/images/products/iforce-protean-large.jpg",
    "name": "Protean",
    "lowest_prices": [
        {
            "flavor": "Strawberry Creamsicle",
            "price": "32.99",
            "size": "4 Lbs.",
            "url": "https://www.priceplow.com/out/iforce/protean?size=4"
        },
        {
            "flavor": "Chocolate Truffle",
            "price": "27.62",
            "size": "2 Lbs.",
            "url": "https://www.priceplow.com/out/iforce/protean?size=2"
        }
    ],
    "prices": {
        "2 Lbs.": [
            [
                {
                    "flavor": "Chocolate Truffle",
                    "price": "27.62",
                    "store": "VitaCost.com",
                    "url": "https://beta.priceplow.com/out/315628"
                },
                {
                    "flavor": "Vanilla Mint Swirl",
                    "price": "34.99",
                    "store": "VitaCost.com",
                    "url": "https://beta.priceplow.com/out/315630"
                }
            ],
            [
                {
                    "flavor": "Chocolate Truffle",
                    "price": "30.99",
                    "store": "Paramount Supplements",
                    "url": "https://beta.priceplow.com/out/800998"
                },
                {
                    "flavor": "Red Velvet Cake",
                    "price": "30.99",
                    "store": "Paramount Supplements",
                    "url": "https://beta.priceplow.com/out/800999"
                },
                {
                    "flavor": "Vanilla Cupcake Batter",
                    "price": "30.99",
                    "store": "Paramount Supplements",
                    "url": "https://beta.priceplow.com/out/801000"
                },
                {
                    "flavor": "Vanilla Mint Swirl",
                    "price": "30.99",
                    "store": "Paramount Supplements",
                    "url": "https://beta.priceplow.com/out/801001"
                }
            ],
            [ ... ], [ ... ]
        ],
        "4 Lbs.": [
            [
                {
                    "flavor": "Strawberry Creamsicle",
                    "price": "32.99",
                    "store": "Best Price Nutrition",
                    "url": "https://beta.priceplow.com/out/753817"
                }
            ],
            [
                {
                    "flavor": "Chocolate Truffle",
                    "price": "39.99",
                    "store": "AllStarHealth.com",
                    "url": "https://beta.priceplow.com/out/807617"
                },
                {
                    "flavor": "Strawberry Creamsicle",
                    "price": "46.75",
                    "store": "AllStarHealth.com",
                    "url": "https://beta.priceplow.com/out/427962"
                }
            ],
            [
                {
                    "flavor": "Chocolate Truffle",
                    "price": "46.75",
                    "store": "World Class Nutrition",
                    "url": "https://beta.priceplow.com/out/708385"
                },
                {
                    "flavor": "Strawberry Creamsicle",
                    "price": "46.75",
                    "store": "World Class Nutrition",
                    "url": "https://beta.priceplow.com/out/708387"
                },
                {
                    "flavor": "Vanilla Cupcake Batter",
                    "price": "46.75",
                    "store": "World Class Nutrition",
                    "url": "https://beta.priceplow.com/out/708386"
                }
            ],
            [
                {
                    "flavor": "Chocolate Truffle",
                    "price": "46.95",
                    "store": "A1 Supplements",
                    "url": "https://beta.priceplow.com/out/728221"
                },
                {
                    "flavor": "Strawberry Creamsicle",
                    "price": "46.95",
                    "store": "A1 Supplements",
                    "url": "https://beta.priceplow.com/out/728222"
                }
            ],
            [ ... ], [ ... ]
        ]
    },
    "thumbnail_image_url": "https://www.priceplow.com/static/images/products/iforce-protean-small.jpg",
    "url": "https://beta.priceplow.com/iforce/protean"
}

Universal Embed Code

This section is coming soon. See the example to the right for an idea of how it will work.

Example Embed Code - Show Giant Sports products

<div class="priceplow-container priceplow-divisible-by-3 priceplow-divisible-by-6" id="priceplow-widget-0"></div>


<script type="text/javascript">
    // <![CDATA[

    var priceplow_settings = new Array();
    // Set Global Settings
    priceplow_settings["api_url_prefix"] = "https://api.priceplow.com/v1/";

    priceplow_settings["link_to_priceplow"] = true;
    priceplow_settings["new_tab_links"] = true;
    priceplow_settings["load_css"] = true;
    priceplow_settings["api_key"] = "41677694b3234b5ebb47fa5e75366cd6";
    priceplow_settings["campaign_id"] = 1;
    priceplow_settings[0] = {"items_to_show":"6","feature_type":"brand","div_identifier":"priceplow-widget-0","brand_id":"150"};

    (function () {
         var s = document.createElement('script'); s.async = true;
         s.type = 'text/javascript';
         s.src = 'https://www.priceplow.com/wp-plugin/js/priceplow.js';
         (document.getElementsByTagName('HEAD')[0] || document.getElementsByTagName('BODY')[0]).appendChild(s);
     }());
     //]]>
</script>

Deals

https://api.priceplow.com/v1/deals

List the current ongoing hot deals that have been manually selected for quality and value by the PricePlow administrators.

These deals can be found at www.priceplow.com/deals.

List active deals

Example Request:

$ curl https://api.priceplow.com/v1/deals?api_key=<key>

Example Response:

[
    {
        "brand": {
            "id": 75, 
            "name": "Cellucor", 
            "thumbnail_image_url": "https://www.priceplow.com/static/images/brands/cellucor-small.jpg", 
            "url": "https://www.priceplow.com/cellucor"
        }, 
        "category": {
            "id": 3, 
            "name": "Whey Protein", 
            "url": "https://www.priceplow.com/whey-protein"
        }, 
        "id": 6752, 
        "large_image_url": "https://www.priceplow.com/static/images/products/cellucor-cor-performance-whey-large.jpg", 
        "lowest_prices": [
            {
                "flavor": "Strawberry Milkshake", 
                "price": "29.99", 
                "size": "2 Lbs.", 
                "url": "https://www.priceplow.com/out/cellucor/cor-performance-whey?size=2"
            }
        ], 
        "name": "COR-Performance Whey", 
        "thumbnail_image_url": "https://www.priceplow.com/static/images/products/cellucor-cor-performance-whey-small.jpg", 
        "url": "https://www.priceplow.com/cellucor/cor-performance-whey",
        "started": "Tue, 01 Apr 2014 14:34:59 -0000", 
    }, 
    {...},
    {...},
]

Response

Returns an array of Product objects. Each object includes an additional started attribute to indicate when the deal started, as a RFC822-formatted date string in UTC.

Search

https://api.priceplow.com/v1/search

Search PricePlow products, brands, and categories.

Search for products, brands, and categories.

Request

GET https://api.priceplow.com/v1/search

Arguments
q: string A URL-encoded search query. Example value: whey+protein.

Example Request:

$ curl https://api.priceplow.com/v1/search?q=protein&api_key=<key>

Response

Returns the url to the corresponding PricePlow search page and an array of search results sorted by relevance. Each search result has the following fields: - type: "product", "brand", or "category". - id: The product/brand/category ID. - url: The product/brand/category URL. - name: The name of the product/brand/category.

Example Response:

{
    "url": "https://www.priceplow.com/search?q=protein",
    "results": [
        {
            "id": 2919, 
            "name": "Dymatize Elite Gourmet Protein", 
            "type": "product", 
            "url": "https://www.priceplow.com/dymatize/elite-gourmet-protein"
        }, 
        {
            "id": 49475, 
            "name": "PES Select Protein", 
            "type": "product", 
            "url": "https://www.priceplow.com/pes/select-protein"
        }, 
        {
            "id": 2, 
            "name": "Protein", 
            "type": "category", 
            "url": "https://www.priceplow.com/protein"
        }, 
        {
            "id": 11, 
            "name": "Protein Powder", 
            "type": "category", 
            "url": "https://www.priceplow.com/protein-powder"
        }, 
        {
            "id": 3, 
            "name": "Whey Protein", 
            "type": "category", 
            "url": "https://www.priceplow.com/whey-protein"
        }, 
        {
            "id": 4, 
            "name": "Whey Protein Isolate", 
            "type": "category", 
            "url": "https://www.priceplow.com/whey-protein-isolate"
        }, 
        {
            "id": 15730, 
            "name": "MTS Nutrition Machine Whey Protein", 
            "type": "product", 
            "url": "https://www.priceplow.com/mts-nutrition/machine-whey-protein"
        }, 
        {
            "id": 40052, 
            "name": "HealthSmart CarbThin Zero Carb Egg Protein Shake Mix", 
            "type": "product", 
            "url": "https://www.priceplow.com/healthsmart/carbthin-zero-carb-egg-protein-shake-mix"
        }, 
        {
            "id": 1, 
            "name": "Optimum Nutrition 100% Whey Protein Gold Standard", 
            "type": "product", 
            "url": "https://www.priceplow.com/optimum-nutrition/100-whey-protein-gold-standard"
        }, 
        {
            "id": 35205, 
            "name": "USP Labs OxyELITE Protein", 
            "type": "product", 
            "url": "https://www.priceplow.com/usp-labs/oxyelite-protein"
        }, 
        {
            "id": 51453, 
            "name": "ARO Whey Protein Isolate", 
            "type": "product", 
            "url": "https://www.priceplow.com/aro/whey-protein-isolate"
        }, 
        {
            "id": 3841, 
            "name": "AllMax Nutrition ISOFLEX Instant Protein Drink", 
            "type": "product", 
            "url": "https://www.priceplow.com/allmax-nutrition/isoflex-instant-protein-drink"
        }, 
        {
            "id": 2889, 
            "name": "Dymatize Elite Whey Protein", 
            "type": "product", 
            "url": "https://www.priceplow.com/dymatize/elite-whey-protein"
        }, 
        {
            "id": 3011, 
            "name": "Dymatize All Natural Elite Whey Protein Isolate", 
            "type": "product", 
            "url": "https://www.priceplow.com/dymatize/all-natural-elite-whey-protein-isolate"
        }, 
        {
            "id": 51897, 
            "name": "ANSI Gourmet Cheesecake Protein Bars", 
            "type": "product", 
            "url": "https://www.priceplow.com/ansi/gourmet-cheesecake-protein-bars"
        }, 
        {
            "id": 43, 
            "name": "Optimum Nutrition 100% Casein Protein Gold Standard", 
            "type": "product", 
            "url": "https://www.priceplow.com/optimum-nutrition/100-casein-protein-gold-standard"
        }, 
        {
            "id": 51610, 
            "name": "ARO Whey Protein Complex PLUS", 
            "type": "product", 
            "url": "https://www.priceplow.com/aro/whey-protein-complex-plus"
        }, 
        {
            "id": 7978, 
            "name": "Top Secret Nutrition 100% Whey Protein", 
            "type": "product", 
            "url": "https://www.priceplow.com/top-secret-nutrition/100-whey-protein"
        }, 
        {
            "id": 35609, 
            "name": "Spartos Sugar Free Protein Water", 
            "type": "product", 
            "url": "https://www.priceplow.com/spartos/sugar-free-protein-water"
        }, 
        {
            "id": 46901, 
            "name": "Side Effect Sports Prime Protein", 
            "type": "product", 
            "url": "https://www.priceplow.com/side-effect-sports/prime-protein"
        }, 
        {
            "id": 6743, 
            "name": "NOW Whey Protein", 
            "type": "product", 
            "url": "https://www.priceplow.com/now/whey-protein"
        }, 
        {
            "id": 31122, 
            "name": "Jarrow Formulas Organic Whey Protein", 
            "type": "product", 
            "url": "https://www.priceplow.com/jarrow-formulas/organic-whey-protein"
        }, 
        {
            "id": 26137, 
            "name": "Jarrow Formulas 100% Natural Whey Protein", 
            "type": "product", 
            "url": "https://www.priceplow.com/jarrow-formulas/100-natural-whey-protein"
        }, 
        {
            "id": 1926, 
            "name": "NOW Premium Whey Protein", 
            "type": "product", 
            "url": "https://www.priceplow.com/now/premium-whey-protein"
        }, 
        {
            "id": 375, 
            "name": "Supreme Protein", 
            "type": "brand", 
            "url": "https://www.priceplow.com/primal-protein"
        }, 
        {
            "id": 330, 
            "name": "Pure Protein", 
            "type": "brand", 
            "url": "https://www.priceplow.com/supreme-protein"
        }, 
        {
            "id": 325, 
            "name": "Protein Squared", 
            "type": "brand", 
            "url": "https://www.priceplow.com/pure-protein"
        }, 
        {
            "id": 290, 
            "name": "Only Protein", 
            "type": "brand", 
            "url": "https://www.priceplow.com/only-protein"
        }, 
        {
            "id": 2089, 
            "name": "Primal Protein", 
            "type": "brand", 
            "url": "https://www.priceplow.com/protein-squared"
        }, 
        {
            "id": 921, 
            "name": "High Protein Snacks", 
            "type": "category", 
            "url": "https://www.priceplow.com/high-protein-snacks"
        }
    ]
}

Errors

The PricePlow API uses the following error codes:

Error Code Meaning
400 Bad Request – Your request makes no sense / is syntactically wrong
401 Unauthorized – Your API key is wrong
404 Not Found – The specified endpoint could not be found
500 Internal Server Error – We had a problem with our server. Try again later.

Terms and Conditions

By using this API, you agree to the terms and conditions set forth at www.priceplow.com/api/terms.