API REFERENCE

Shopify Store List API

Use the Shopify store list API to filter stores by URL, tags, region and monthly visits. Review request parameters, cURL examples, JSON responses and credit usage below.

GET/open-api/v1/shop

Each record retrieved deducts 1 credits·api.ppspy.com

Data and monitoring usage rules

Points Consumption Rules: 1. Retrieving a Shopify data result consumes 1 data, while retrieving an ad library data result consumes 2 data. Retrieving additional data details for a data result does not consume data. 2. Ad monitoring and sales monitoring: Each monitoring session costs $1/month. Each monitoring session is valid for one month and automatically expires after one month. Deleting a monitoring session does not restore the monitoring session, so please delete with caution. Monitoring sessions can be accessed at any time and are unlimited.

Request headers

AUTHORIZATIONAuthorization: {API Key}

CONTENT-TYPEapplication/json

ACCEPTapplication/json

Request example

cURL

curl --location --request GET 'https://api.ppspy.com/open-api/v1/shop' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}'

Request parameters 35 fields

Pass each parameter in its specified location.

Parameter	Type	Description
url query · optional	string	Store URL(s). Multiple values should be comma-separated.
tags query · optional	string	Tag(s). Multiple values should be comma-separated.
pixel query · optional	string	Ad platform(s). Multiple values should be comma-separated. Valid options: `snap`, `tiktok`, `pinterest`.
last_sold_at_start query · optional	string	Latest order date (start). Format: `Y-m-d` (e.g., `2025-01-01`).
last_sold_at_end query · optional	string	Latest order date (end). Format: `Y-m-d` (e.g., `2025-01-01`).
month_visits_start query · optional	integer	Monthly visits (minimum).
month_visits_end query · optional	integer	Monthly visits (maximum).
published_products_count_start query · optional	integer	Product count (minimum).
published_products_count_end query · optional	integer	Product count (maximum).
language query · optional	string	Store language(s). Multiple values should be comma-separated.
country query · optional	string	Store region(s). Multiple values should be comma-separated.
last_product_published_at_start query · optional	string	Latest product publish date (start). Format: `Y-m-d` (e.g., `2025-01-01`).
last_product_published_at_end query · optional	string	Latest product publish date (end). Format: `Y-m-d` (e.g., `2025-01-01`).
first_product_published_at_start query · optional	string	First product publish date (start). Format: `Y-m-d` (e.g., `2025-01-01`).
first_product_published_at_end query · optional	string	First product publish date (end). Format: `Y-m-d` (e.g., `2025-01-01`).
currency query · optional	string	Currency/Currencies. Multiple values should be comma-separated.
social_media query · optional	string	Social media platform(s). Multiple values should be comma-separated. Valid options: `facebook`, `instagram`, `tiktok`, `twitter`, `pinterest`, `youtube`.
themes query · optional	string	Search shops by theme name.
app query · optional	string	Search shops by installed apps.
pixel_text query · optional	string	Search shops by pixel name/ID.
page query · optional	integer	Page number (min: `1`).
per_page query · optional	integer	Items per page (range: `1-100`).
order_by query · optional	string	Sort field. Valid options: `last_sold_at`, `published_products_count`, `last_product_published_at`, `first_product_published_at`, `month_visits`, `monthly_sale`, `monthly_revenue`.
direction query · optional	string	Sort direction. Valid options: `desc` (descending), `asc` (ascending).
description query · optional	string	Store description(s). Multiple values should be comma-separated.
title query · optional	string	Store name(s). Multiple values should be comma-separated.
exclude_title query · optional	string	Exclude store name(s). Multiple values should be comma-separated.
exclude_url query · optional	string	Exclude store URL(s). Multiple values should be comma-separated.
exclude_description query · optional	string	Exclude store description(s). Multiple values should be comma-separated.
monthly_sale_start query · optional	integer	Monthly sales (minimum).
monthly_sale_end query · optional	integer	Monthly sales (maximum).
monthly_revenue_start query · optional	number	Monthly revenue (minimum).
monthly_revenue_end query · optional	number	Monthly revenue (maximum).
category_tags query · optional	string	Product type(s). Multiple values should be comma-separated. Valid options: `1`-Dropshipping, `2`-Print on demand (POD), `3`-Cash on delivery (COD), `4`-Digital products.
shield_shop query · optional	integer	Filter suspicious shops. Options: `1`-yes, `2`-no.

Response example

Response · JSON

{
    "code": 200,
    "message": "Success",
    "data": {
        "data": [
            {
                "id": 51071713450,
                "name": "BloomChic",
                "web_snapshot": "https://web-screenshot.ppspy.com/shopify/123.jpeg",
                "url": "https://bloomchic.com",
                "domain": "bloomchic.com",
                "tags": ["pocket", "dress", "solid", "neck", "sleeve", "ruffle", "floral", "button", "hem", "v"],
                "month_visits": 1152049,
                "last_sold_at": 1678860714,
                "country": "HK",
                "monthly_sale": 67521,
                "monthly_revenue": 1800201.3,
                "published_products_count": 4890,
                "currency": "USD",
                "first_product_published_at": 1615691957,
                "category_tags": null,
                "user_collected": 0,
                "newest_product_data": [
                    {
                        "id": 7703375282346,
                        "images": ["https://cdn.shopify.com/.../1df8dcbc-...jpg"]
                    },
                    {
                        "id": 7702865936554,
                        "images": ["https://cdn.shopify.com/.../61404126_sy.jpg"]
                    }
                ],
                "monthly_revenue_usd": 1800201.3
            },
            {
                "id": 1566146,
                "name": "Gymshark US",
                "web_snapshot": null,
                "url": "https://www.gymshark.com",
                "domain": "www.gymshark.com",
                "tags": ["gymshark", "black", "seamless", "t-shirt", "grey", ...],
                "month_visits": null,
                "last_sold_at": 1678449318,
                "country": "US",
                "monthly_sale": 54438,
                "monthly_revenue": 1911258.8,
                "published_products_count": 2234,
                "currency": "USD",
                "first_product_published_at": 1473349821,
                "category_tags": null,
                "user_collected": 0,
                "newest_product_data": [
                    {
                        "id": 6805157380298,
                        "images": ["https://cdn.shopify.com/.../GfxMaxedOut...jpg"]
                    }
                ],
                "monthly_revenue_usd": 1911258.8
            }
        ],
        "last_page": 428997,
        "current_page": 1,
        "total": 857993,
        "per_page": 2
    }
}

Example data from the existing documentation

Response structure

Name	Type	Required	Constraints	Description
code	integer	true	none	Status Code
message	string	true	none	Response message
data	object	true	none	Response data
» data	[object]	true	none	Data list
»» id	integer	true	none	Shop ID
»» country	string	true	none	Shop country
»» name	string	true	none	Shop name
»» web_snapshot	string \| null	true	none	Website snapshot URL
»» url	string	true	none	Shop URL
»» domain	string	true	none	Shop domain
»» tags	[string]	true	none	Shop tags
»» month_visits	integer \| null	true	none	Monthly visits
»» user_collected	integer	true	none	Indicates whether the user has favorited this shop: `0` = Not favorited, `1` = Favorited
»» newest_product_data	[object]	true	none	Newest products
»»» id	integer	true	none	Product ID
»»» images	[string]	true	none	Product images
»» last_sold_at	integer	true	none	Last order timestamp
»» monthly_sale	integer \| null	true	none	Monthly sales
»» monthly_revenue	number \| null	true	none	Monthly revenue
»» published_products_count	integer	true	none	Product count
»» currency	string	true	none	Currency
»» category_tags	[integer] \| null	true	none	Product type tags
»» monthly_revenue_usd	number \| null	true	none	Monthly revenue (USD)
»» last_page	integer	true	none	Last page number
»» current_page	integer	true	none	Current page number
»» total	integer	true	none	Total records
»» per_page	integer	true	none	Items per page
» credits	object	true	none	Credits information
»» remaining_credits	integer	true	none	Remaining credits
»» consumed_credits	integer	true	none	Consumed credits
»» total_credits	integer	true	none	Total credits

Original API information and base URL

Base URLs

Production Environment: https://api.ppspy.com

API Information

API Name: Shopify Store List
Request Method: GET
API URL: /open-api/v1/shop
Cost: Each record retrieved deducts 1 credits