--- title: Common slug: redcircleapi/target-product-data-api/parameters/common docTags: createdAt: 2024-07-28T10:34:19.773Z --- # Common Parameters `GET` `/request` The following parameters are used to configure your request to the Target Product Data API. They should be appended as querystring parameters to a `GET` HTTP request to the `/request` endpoint. For example, to request search results, for the search term `highlighter pens` sorted by `best_seller` the request would be: :::CodeblockTabs HTTP ```HTTP https://api.redcircleapi.com/request?api_key=demo&type=search&search_term=highlighter+pens&sort_by=best_seller ``` ```curl curl -L --get https://api.redcircleapi.com/request \ -d api_key="demo" \ -d type="search" \ -d search_term="highlighter+pens" \ -d sort_by="best_seller" ``` ```nodejs const axios = require('axios'); // set up the request parameters const params = { api_key: "demo", type: "search", search_term: "highlighter pens", sort_by: "best_seller" } // make the http GET request to RedCircle API axios.get('https://api.redcircleapi.com/request', { params }) .then(response => { // print the JSON response from RedCircle API console.log(JSON.stringify(response.data, 0, 2)); }).catch(error => { // catch and print the error console.log(error); }) ``` ```python import requests import json # set up the request parameters params = { 'api_key': 'demo', 'type': 'search', 'search_term': 'highlighter pens', 'sort_by': 'best_seller' } # make the http GET request to RedCircle API api_result = requests.get('https://api.redcircleapi.com/request', params) # print the JSON response from RedCircle API print(json.dumps(api_result.json())) ``` ```php 'demo', 'type' => 'search', 'search_term' => 'highlighter pens', 'sort_by' => 'best_seller' ]); # make the http GET request to RedCircle API $ch = curl_init(sprintf('%s?%s', 'https://api.redcircleapi.com/request', $queryString)); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); # the following options are required if you're using an outdated OpenSSL version # more details: https://www.openssl.org/blog/blog/2021/09/13/LetsEncryptRootCertExpire/ curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); curl_setopt($ch, CURLOPT_TIMEOUT, 180); $api_result = curl_exec($ch); curl_close($ch); # print the JSON response from RedCircle API echo $api_result; ?> ``` ::: :::hint{type="info"} **Request-Specific Parameters** Additional parameters are available depending on the type of request being made (as-determined by the `type` parameter). For example, if you make a request with `type=product` then additional [Product Parameters](https://docs.trajectdata.com/redcircleapi/target-product-data-api/parameters/product), specific to `product` requests, are available. ::: *** ### Common Parameters The following common parameters are required for all requests to the Target Product Data API. | *`Parameter`* | *`Required`* | *`Description`* | | -------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | *`api_key`* | *`required`* | The API key for your RedCircle API account. | | *`type`* | *`required`* | The type of Target data to retrieve. The value of the `type` parameter determines which additional parameters are available. For example, if you make a request with `type=search` then additional [Search Parameters ](https://docs.trajectdata.com/redcircleapi/target-product-data-api/parameters/search), specific to `search` requests, are available.
Valid values for `type` are:
1. `search`
2. Request search results for a `search_term` or Target search results page `url` . See additional [Search Parameters ](https://docs.trajectdata.com/redcircleapi/target-product-data-api/parameters/search).

1. `category`
2. Request category-listing results for a `category_id` or Target search results page `url` . See additional [Category Parameters ](https://docs.trajectdata.com/redcircleapi/target-product-data-api/parameters/category).

1. `product`
2. Request data from a Target product page via a Target `tcin` (item ID) or Target product page `url` . See additional [Product Parameters ](https://docs.trajectdata.com/redcircleapi/target-product-data-api/parameters/product).

1. `reviews`
2. Request customer reviews for a Target `tcin` (item ID) or Target product page `url` . See additional [Reviews Parameters ](https://docs.trajectdata.com/redcircleapi/target-product-data-api/parameters/reviews).

1. `store_stock `
2. Request in-store stock data for a given `tcin` for Target stores in the vicinity of the given zipcode. See additional [Store Stock Parameters ](https://docs.trajectdata.com/redcircleapi/target-product-data-api/parameters/store-stock). | | *`customer_zipcode`* | *`optional`* | Determines the zipcode or postal code location that RedCircle uses when retrieving pages. Results will be retrieved from the Target Store nearest to the supplied `customer_zipcode` . | | *`output`* | *`optional`* | Determines the format in which results are returned. Can be set to `json` (default) to get the results as structured JSON, or `csv` to return the results in CSV format. When using `csv` you can also use the `csv_fields` parameter to specify which fields to return in the CSV. | | *`csv_fields`* | *`optional`* | Determines the fields that are returned when returning in `csv` mode (i.e. when the `output` parameter is set to `csv` ). Should be specified as a comma seperated list of fields (in nested field, dot notation, format). For more information on the `csv_fields` parameter please see the [CSV Fields Reference ](https://docs.trajectdata.com/redcircleapi/target-product-data-api/reference/csv-fields). | | *`include_fields`* | *`optional`* | A comma-seperated list JSON field names to **include** in the JSON object the API returns. You can specify the field names in dot notation - i.e. `include_fields=pagination` will only include the the `pagination` property in the response JSON. Use `include_fields` if you only want to include specific fields in the API's JSON response. | | *`exclude_fields`* | *`optional`* | A comma-seperated list of JSON field names to **exclude** from the JSON object the API returns. You can specify the field names in dot notation - i.e. `exclude_fields=pagination` will remove the `pagination` property from the response JSON. Use `exclude_fields` if there are specific fields you wish to exclude from the API's JSON response. | *** **Next Steps**      [Search Parameters](https://docs.trajectdata.com/redcircleapi/target-product-data-api/parameters/search)      [Category Parameters](https://docs.trajectdata.com/redcircleapi/target-product-data-api/parameters/category)      [Product Parameters](https://docs.trajectdata.com/redcircleapi/target-product-data-api/parameters/product)      [Reviews Parameters](https://docs.trajectdata.com/redcircleapi/target-product-data-api/parameters/reviews)      [Store Stock Parameters](https://docs.trajectdata.com/redcircleapi/target-product-data-api/parameters/store-stock)