Etsy

You can get Etsy results by providing your own URLs to our service. We can return the HTML for any Etsy page you like. Additionally, we can deliver structured (parsed) output for Etsy product pages.

Request samples

The samples below illustrates how you can get a parsed Etsy product page result.

cURL

curl 'https://realtime.oxylabs.io/v1/queries' \
--user 'USERNAME:PASSWORD' \
-H 'Content-Type: application/json' \
-d '{
        "source": "universal_ecommerce", 
        "url": "https://www.etsy.com/listing/524233279/tiny-silver-forget-me-not-earrings", 
        "geo_location": "United States",
        "parse": true
    }'

Python

import requests
from pprint import pprint


# Structure payload.
payload = {
    'source': 'universal_ecommerce',
    'url': 'https://www.etsy.com/listing/524233279/tiny-silver-forget-me-not-earrings',
    'geo_location': 'United States',
    'parse': True,
}

# Get response.
response = requests.request(
    'POST',
    'https://realtime.oxylabs.io/v1/queries',
    auth=('USERNAME', 'PASSWORD'),
    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: "universal_ecommerce",
    url: "https://www.etsy.com/listing/524233279/tiny-silver-forget-me-not-earrings",
    geo_location: "United States",
    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=universal_ecommerce&url=https%3A%2F%2Fwww.etsy.com%2Flisting%2F524233279%2Ftiny-silver-forget-me-not-earrings&geo_location=United%20States&parse=true&access_token=12345abcde

PHP

<?php

$params = array(
    'source' => 'universal_ecommerce',
    'url' => 'https://www.etsy.com/listing/524233279/tiny-silver-forget-me-not-earrings',
    'geo_location' => 'United States',
    '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":       "universal_ecommerce",
		"url":          "https://www.etsy.com/listing/524233279/tiny-silver-forget-me-not-earrings",
		"geo_location": "United States",
		"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 = "universal_ecommerce",
                url = "https://www.etsy.com/listing/524233279/tiny-silver-forget-me-not-earrings",
                geo_location = "United States",
                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", "universal_ecommerce");
        jsonObject.put("url", "https://www.etsy.com/listing/524233279/tiny-silver-forget-me-not-earrings");
        jsonObject.put("geo_location", "United States");
        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": "universal_ecommerce", 
    "url": "https://www.etsy.com/listing/524233279/tiny-silver-forget-me-not-earrings", 
    "geo_location": "United States",
    "parse": true
}

We use Realtime integration method in our examples. If you would like to use some other integration method in your request (e.g. Push-Pull or Proxy Endpoint), refer to the integration methods section.

Request parameter values

Generic

Parameter	Description	Default Value
source	Sets the scraper.	universal_ecommerce
url	Direct URL (link) to any page.	-
render	Enables JavaScript rendering when set to html. More info.	-
parse	Returns parsed data when set to true. Explore output data dictionary.	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
geo_location	Sets the proxy's geo location to retrieve data. Find supported locations here.	-

- mandatory parameter

Please note that you will scrape Etsy by employing the universal_ecommerce source. To learn about all the various ways you can fine-tune this source, please visit this page.

Structured data

E-Commerce Scraper API can extract Etsy product results in either HTML or JSON format, providing structured data on various elements of the page.

Output example

{
    "results": [
        {
            "content": {
                "url": "https://www.etsy.com/listing/1518307138/personalized-travel-jewelry-box-small",
                "price": 6.98,
                "title": "Personalized travel jewelry box, small square earring organizer, bridesmaid gifts box for sister, friend",
                "images": [
                    "https://i.etsystatic.com/41680084/r/il/f09928/5191407963/il_75x75.5191407963_rurr.jpg",
                    "https://i.etsystatic.com/41680084/r/il/c9a00d/5191407709/il_75x75.5191407709_nqq5.jpg",
                    "https://i.etsystatic.com/41680084/r/il/52b188/5179396963/il_75x75.5179396963_pzw9.jpg",
                    "https://i.etsystatic.com/41680084/r/il/ce5219/5191407739/il_75x75.5191407739_k1s6.jpg",
                    "https://i.etsystatic.com/41680084/r/il/23c7e1/5143187268/il_75x75.5143187268_2tsi.jpg",
                    "https://i.etsystatic.com/41680084/r/il/96f059/5143187294/il_75x75.5143187294_1swc.jpg"
                ],
                "seller": {
                    "url": "https://www.etsy.com/shop/EnchVows?ref=shop-header-name&listing_id=1518307138&from_page=listing",
                    "title": "EnchVows",
                    "rating": 4.8247,
                    "best_seller": false,
                    "star_seller": true,
                    "reviews_count": 3016
                },
                "reviews": {
                    "count": 1875
                },
                "currency": "USD",
                "shipping": {
                    "from": "United States"
                },
                "old_price": 19.95,
                "categories": [
                    {
                        "title": "All categories"
                    },
                    {
                        "title": "Jewelry"
                    },
                    {
                        "title": "Jewelry Storage"
                    },
                    {
                        "title": "Jewelry Boxes"
                    }
                ],
                "customized": false,
                "product_id": "1518307138",
                "variation_count": 36,
                "parse_status_code": 12000
            },
            "created_at": "2024-06-13 11:59:06",
            "updated_at": "2024-06-13 11:59:13",
            "page": 1,
            "url": "https://www.etsy.com/de-en/listing/1518307138/personalized-travel-jewelry-box-small?click_key=d602fe08540deffc77a9e2c6ab6cee6d2c2ca74a:1518307138&click_sum=a7bd4b3c&ref=hp_prn-2&pro=1&sts=1",
            "job_id": "7206988452519233537",
            "status_code": 200,
            "parser_type": "etsy_product"
        }
    ]
}

Output data dictionary

HTML example

JSON Structure

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

Key	Description	Type
url	The URL of the Etsy product page.	string
price	The price of the product.	integer
title	The title of the product.	string
images	Array of URLs to product images.	array
seller	The seller object, containing seller details.	object
reviews	The reviews object, containing review details.	object
reviews.count	The number of reviews received for the product.	integer
currency	The currency in which the price is denominated.	string
shipping	The shipping object, containing shipping details.	object
shipping.from	The origin country of shipping.	string
old_price	The previous price of the product before discount.	integer
categories	Array of category objects to which the product belongs.	array
categories.title	The title of the category.	string
customized	Indicates whether the product can be customized.	boolean
product_id	The unique identifier for the product.	string
variation_count	The number of variations available for the product.	integer
parse_status_code	The status code of the parsing job. You can see the parser status codes described here.	integer
created_at	The timestamp when the scraping job was created.	timestamp
updated_at	The timestamp when the scraping job was finished.	timestamp
page	The page number in the pagination of 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.	integer
job_id	The ID of the job associated with the scraping job.	string

Sellers

The seller object, containing details of the seller.

...
"seller": {
    "url": "https://www.etsy.com/shop/EnchVows?ref=shop-header-name&listing_id=1518307138&from_page=listing",
    "title": "EnchVows",
    "rating": 4.8247,
    "best_seller": false,
    "star_seller": true,
    "reviews_count": 3016
},
...

Key (Seller)	Description	Type
url	The URL of the seller's page.	string
title	The name of the seller.	string
rating	The rating score of the seller.	integer
best_seller	Indicates whether the seller is a best seller.	boolean
star_seller	Indicates whether the seller is a star seller.	boolean
reviews_count (optional)	The number of reviews for the seller.	integer