Search

The target_search source is designed to retrieve Target search result pages. We can return the HTML for any Target page you like. Additionally, we can deliver structured (parsed) output for Target search pages.

Request samples

The example below illustrates how you can get a parsed Target search page result.

cURL

curl 'https://realtime.oxylabs.io/v1/queries' \
--user 'USERNAME:PASSWORD' \
-H 'Content-Type: application/json' \
-d '{
        "source": "target_search", 
        "query": "iphone",
        "render": "html",
        "parse": true
    }'

Python

import requests
from pprint import pprint


# Structure payload.
payload = {
    'source': 'target_search',
    'query': 'iphone',
    'render': 'html',
    'parse': True,
}

# Get response.
response = requests.request(
    'POST',
    'https://realtime.oxylabs.io/v1/queries',
    auth=('user', 'pass1'),
    json=payload,
)

# Instead of response with job status and results url, this will return the
# JSON response with the result.
pprint(response.json())

Node.js

const https = require("https");

const username = "USERNAME";
const password = "PASSWORD";
const body = {
    source: "target_search",
    query: "iphone",
    render: "html",
    parse: true,
};

const options = {
    hostname: "realtime.oxylabs.io",
    path: "/v1/queries",
    method: "POST",
    headers: {
        "Content-Type": "application/json",
        Authorization:
            "Basic " + Buffer.from(`${username}:${password}`).toString("base64"),
    },
};

const request = https.request(options, (response) => {
    let data = "";

    response.on("data", (chunk) => {
        data += chunk;
    });

    response.on("end", () => {
        const responseData = JSON.parse(data);
        console.log(JSON.stringify(responseData, null, 2));
    });
});

request.on("error", (error) => {
    console.error("Error:", error);
});

request.write(JSON.stringify(body));
request.end();

HTTP

# The whole string you submit has to be URL-encoded.

https://realtime.oxylabs.io/v1/queries?source=target_search&query=iphone&render=html&parse=true&access_token=12345abcde

PHP

<?php

$params = array(
    'source' => 'target_search',
    'query' => 'iphone',
    'render' => 'html',
    'parse' => true
);

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://realtime.oxylabs.io/v1/queries");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($params));
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_USERPWD, "USERNAME" . ":" . "PASSWORD");

$headers = array();
$headers[] = "Content-Type: application/json";
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);
echo $result;

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}
curl_close($ch);

Golang

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"io/ioutil"
	"net/http"
)

func main() {
	const Username = "USERNAME"
	const Password = "PASSWORD"

	payload := map[string]interface{}{
		"source":       "target_search",
		"query":        "iphone",
		"render":       "html",
		"parse":        true,
	}

	jsonValue, _ := json.Marshal(payload)

	client := &http.Client{}
	request, _ := http.NewRequest("POST",
		"https://realtime.oxylabs.io/v1/queries",
		bytes.NewBuffer(jsonValue),
	)

	request.SetBasicAuth(Username, Password)
	response, _ := client.Do(request)

	responseText, _ := ioutil.ReadAll(response.Body)
	fmt.Println(string(responseText))
}

C#

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Json;
using System.Threading.Tasks;

namespace OxyApi
{
    class Program
    {
        static async Task Main()
        {
            const string Username = "USERNAME";
            const string Password = "PASSWORD";

            var parameters = new {
                source = "target_search",
                url = "iphone",
                render = "html",
                parse = true
            };

            var client = new HttpClient();

            Uri baseUri = new Uri("https://realtime.oxylabs.io");
            client.BaseAddress = baseUri;

            var requestMessage = new HttpRequestMessage(HttpMethod.Post, "/v1/queries");
            requestMessage.Content = JsonContent.Create(parameters);

            var authenticationString = $"{Username}:{Password}";
            var base64EncodedAuthenticationString = Convert.ToBase64String(System.Text.ASCIIEncoding.UTF8.GetBytes(authenticationString));
            requestMessage.Headers.Add("Authorization", "Basic " + base64EncodedAuthenticationString);

            var response = await client.SendAsync(requestMessage);
            var contents = await response.Content.ReadAsStringAsync();

            Console.WriteLine(contents);
        }
    }
}

Java

package org.example;

import okhttp3.*;
import org.json.JSONObject;
import java.util.concurrent.TimeUnit;

public class Main implements Runnable {
    private static final String AUTHORIZATION_HEADER = "Authorization";
    public static final String USERNAME = "USERNAME";
    public static final String PASSWORD = "PASSWORD";

    public void run() {
        JSONObject jsonObject = new JSONObject();
        jsonObject.put("source", "target_search");
        jsonObject.put("query", "iphone");
        jsonObject.put("render", "html");
        jsonObject.put("parse", true);

        Authenticator authenticator = (route, response) -> {
            String credential = Credentials.basic(USERNAME, PASSWORD);
            return response
                    .request()
                    .newBuilder()
                    .header(AUTHORIZATION_HEADER, credential)
                    .build();
        };

        var client = new OkHttpClient.Builder()
                .authenticator(authenticator)
                .readTimeout(180, TimeUnit.SECONDS)
                .build();

        var mediaType = MediaType.parse("application/json; charset=utf-8");
        var body = RequestBody.create(jsonObject.toString(), mediaType);
        var request = new Request.Builder()
                .url("https://realtime.oxylabs.io/v1/queries")
                .post(body)
                .build();

        try (var response = client.newCall(request).execute()) {
            if (response.body() != null) {
                try (var responseBody = response.body()) {
                    System.out.println(responseBody.string());
                }
            }
        } catch (Exception exception) {
            System.out.println("Error: " + exception.getMessage());
        }

        System.exit(0);
    }

    public static void main(String[] args) {
        new Thread(new Main()).start();
    }
}

JSON

{
    "source": "target_search", 
    "query": "iphone", 
    "render": "html",
    "parse": true
}

We use synchronous Realtime integration method in our examples. If you would like to use Proxy Endpoint or asynchronous Push-Pull integration, refer to the integration methods section.

Request parameter values

Generic

Parameter	Description	Default Value
source	Sets the scraper.	target_search
query	The keyword or phrase to search for products.	-
render	Enables JavaScript rendering when set to html. More info.	-
parse	Returns parsed data when set to true.	false
callback_url	URL to your callback endpoint. More info.	-
user_agent_type	Device type and browser. The full list can be found here.	desktop

- mandatory parameter

Localization

Adapt results to specific stores, fulfillment type, delivery locations.

Parameter	Description	Type
fulfillment_type	Set the fulfillment type. Available values are: pickup, shipping, shop_in_store, same_day_delivery.	String
store_id	Set the store location.	Integer
delivery_zip	Set the shipping to location.	String

Output data dictionary

HTML example

"content": {
    "url": "https://www.target.com/s?searchTerm=iphone&tref=typeahead%7Cterm%7Ciphone%7C%7C%7Chistory",
    "results": {
        "organic": [
            {
                "url": "https://www.target.com/p/refurbished-at-38-t-apple-iphone-12-128gb-black-target-certified-refurbished/-/A-90500508#lnk=sametab",
                "title": "Refurbished AT&T Apple iPhone 12 (128GB) - Black - Target Certified Refurbished",
                "brand_link": "https://www.target.com/b/apple/-/N-5y3ej",
                "brand_name": "Apple",
                "price_data": {
                    "price": 380.79,
                    "currency": "USD",
                    "comparison_price": 475.99
                },
                "product_id": "90500508",
                "rating_data": {
                    "count": 0,
                    "score": 0
                },
                "shipping_message": "Ships freeExclusions applyGet it by Tue, Jul 9"
            },
                        ...
        ]
    },
    "parse_status_code": 12000
},
"created_at": "2024-07-03 10:48:01",
"updated_at": "2024-07-03 10:48:32",
"page": 1,
"url": "https://www.target.com/s?searchTerm=iphone&tref=typeahead%7Cterm%7Ciphone%7C%7C%7Chistory",
"job_id": "7214218323129556993",
"status_code": 200,
"parser_type": "target_search",
		...
}

JSON structure

The table below presents a detailed list of search results page element we parse, along with its description and data type. The table also includes some metadata.

Key	Description	Key Type
url	The URL of the search results page.	String
results	Container for the search results.	Dictionary
organic	List of organic (non-paid) search results.	List
organic.url	The URL of the individual product page.	String
organic.title	The title of the product.	String
organic.brand_link	The URL to the brand page.	String
organic.brand_name	The name of the brand.	String
organic.price_data	Container for the product price data.	Dictionary
organic.price_data.price	The price of the product.	Float
organic.price_data.currency	The currency of the price.	String
organic.price_data.upper_price	The upper price if there is a price range.	Float
organic.product_id	The unique product ID.	String
organic.rating_data	Container for the product rating data.	Dictionary
organic.rating_data.count	The number of ratings.	Integer
organic.rating_data.score	The average rating score.	Float
organic.rating_data.reviews_url	The URL to the reviews page.	String
organic.shipping_message	The shipping information for the product.	String
created_at	The timestamp when the scraping job was created.	String
updated_at	The timestamp when the scraping job was finished.	String
parse_status_code	The status code of the parsing job. You can see the parser status codes described here.	Integer
page	The page number of the search results	Integer
status_code	The status code of the scraping job. You can see the scraper status codes described here.	Integer
parser_type	The type of parser used to extract the data.	String
job_id	The ID of the job associated with the scraping job.	String