Core APIs
...
Core Requests
Search
3 min
search parameters get get /request the search parameters are applicable when making a request with type=search to retrieve search results from target the search term is specified in the search term parameter the parameters should be appended as querystring parameters to the target product data api get http request search results are retrieved from the search results page https //www target com/s?searchterm=highlighter+pens on target for example, to request search results for the search term highlighter pens , sorted by "best selling products", the request would be http https //api redcircleapi com/request?api key=demo\&type=search\&search term=highlighter+pens\&sort by=best sellercurl l get https //api redcircleapi com/request \\ d api key="demo" \\ d type="search" \\ d search term="highlighter+pens" \\ d sort by="best seller"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); })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 \# set up the request parameters $querystring = http build query(\[ 'api key' => '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; ?> search parameters the following parameters are available for all requests made when type=search true falsefalse left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type next steps search results https //docs trajectdata com/redcircleapi/target product data api/results/search