API REFERENCE

Shopify Theme Store List API

GET/open-api/v1/shop/theme-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/theme-shop' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}'

Request parameters 25 fields

Pass each parameter in its specified location.

Parameter	Type	Description
url query · optional	string	Store URLs (separate multiple values with commas `,`).
tags query · optional	string	Tags (separate multiple values with commas `,`).
month_visits_start query · optional	integer	Monthly visits range start.
month_visits_end query · optional	integer	Monthly visits range end.
published_products_count_start query · optional	integer	Published products count range start.
published_products_count_end query · optional	integer	Published products count range end.
language query · optional	string	Store languages (separate multiple values with commas `,`).
country query · optional	string	Store regions (separate multiple values with commas `,`).
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	Store creation date start (format: `Y-m-d`, e.g., `2025-01-01`).
first_product_published_at_end query · optional	string	Store creation date end (format: `Y-m-d`, e.g., `2025-01-01`).
currency query · optional	string	Store currencies (separate multiple values with commas `,`).
social_media query · optional	string	Social media platforms (separate multiple values with commas `,`). Options: `facebook`, `instagram`, `tiktok`, `twitter`, `pinterest`, `youtube`.
themes_text query · optional	string	Theme names.
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. Options: `last_sold_at` (last sale), `published_products_count` (product count), `last_product_published_at` (latest product), `first_product_published_at` (store creation), `month_visits` (monthly visits).
direction query · optional	string	Sort direction: `asc` (ascending) or `desc` (descending).
description query · optional	string	Store descriptions (separate multiple values with commas `,`).
title query · optional	string	Store titles (separate multiple values with commas `,`).
exclude_title query · optional	string	Exclude store titles (separate multiple values with commas `,`).
exclude_url query · optional	string	Exclude store URLs (separate multiple values with commas `,`).
exclude_description query · optional	string	Exclude store descriptions (separate multiple values with commas `,`).
category_tags query · optional	string	Product types (separate multiple values with commas `,`). Options: `1`-Dropshipping, `2`-Print on demand (POD), `3`-Cash/collect on delivery (COD), `4`-Digital products.

Response example

Response · JSON

{
    "code": 200,
    "message": "success",
    "data": {
        "data": [
            {
                "id": 51071713450,
                "name": "BloomChic",
                "url": "https://bloomchic.com",
                "domain": "bloomchic.com",
                "boom_theme": "Impulse",
                "shopify_theme": "生产环境",
                "web_snapshot": "https://web-screenshot.ppspy.com/shopify/123.jpeg",
                "first_product_published_at": 1615691957,
                "category_tags": null
            },
            {
                "id": 499112,
                "name": "Bodega  Store",
                "url": "https://bdgastore.com",
                "domain": "bdgastore.com",
                "boom_theme": null,
                "shopify_theme": "bodega-shopify/main",
                "web_snapshot": "https://web-screenshot.ppspy.com/shopify/c8b0a325fefe5f638fa9e36bfe263d46.jpeg",
                "first_product_published_at": 1462909661,
                "category_tags": null
            }
        ],
        "last_page": 53,
        "current_page": 1,
        "total": 105,
        "per_page": 2
    },
    "credits": {
        "remaining_credits": 745,
        "consumed_credits": 0,
        "total_credits": 745
    }
}

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 payload
»» data	[object]	true	none	Data list
»»» id	integer	true	none	Store ID
»»» name	string	true	none	Store name
»»» url	string	true	none	Store URL
»»» domain	string	true	none	Store domain
»»» boom_theme	string \| null	true	none	Theme name
»»» shopify_theme	string \| null	true	none	Custom theme name
»»» web_snapshot	string \| null	true	none	Website snapshot
»»» first_product_published_at	integer \| null	true	none	Creation date
»» 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 Theme Store List
Request Method: GET
API URL: /open-api/v1/shop/theme-shop
Cost: Each record retrieved deducts 1 credits