API Reference

Table of Contents

Overview

The Store Leads API is organized around REST. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP verbs, which are understood by off-the-shelf HTTP clients. JSON is returned by all API responses, including errors.

The example requests within our documentation are shown using your personal API key. This is done for your convenience, so that you can cut and paste the examples. Be sure to keep your personal API key private.

Authentication

Authenticate your account by including your API key in requests. You can see your API key on your Account page.

Authentication is done by including your API key in an HTTP Authorization header.

Authorization: Bearer your.api.key

All API requests must be made over HTTPS. API requests without authentication will fail.

Errors

We use conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, etc.). Codes in the 5xx range indicate an error with our servers (these are rare).


Resources

Apps

App objects represent an app that a store can install through the e-commerce platform's App Store. For instance, Merchant Mail is an app that can be installed through the Shopify App Store.

The attributes of the App object are documented below.

app_store_url
The URL of the App's page in the app store.
average_rating
The average rating in reviews of the App.
categories
A comma-separated list of app store categories to which the App belongs.
created_at
The approximate date and time at which the App was created. Note that we do not have accurate times prior to November of 2018.
description
A description of the App.
id
A unique identifier for this App.
icon_url
The URL of the App's icon.
installed_at

The time at which the App was installed by a Domain.

installs
The number of active stores that have the app installed (if known).
name
The name of the App.
plans
A list of the App's pricing plans.
platform
The name of the app's e-commerce platform (e.g., "shopify", "bigcommerce").
removed_at
The time at which the App was removed from the App store. This value is only set for inactive Apps.
review_count
The number of times that the App has been reviewed by stores.
state
The state of the App. Can be one of the following values:
  • Active
  • Inactive (ie. removed from the App Store)
token
A token that identifies the App. Only guaranteed to be unique among Apps on the same platform.
vendor_email
The email address of the entity that created the App.
vendor_name
The name of the entity that created the App.
vendor_url
The URL of the entity that created the App.

Retrieve an App

Retrieves the details of an App. The app is identified by combining the platform name with the app token (e.g., "shopify.marsello")

Example Request

$ curl -H 'Authorization: Bearer your.api.key' 'https://storeleads.app/json/api/v1/all/app/shopify.marsello'

Example Response

{
  "app": {
    "id": "1.marsello",
    "token": "marsello",
    "name": "Marsello",
    "categories": [
      "marketing"
    ],
    "app_store_url": "https://apps.shopify.com/marsello",
    "plans": [
      {
        "name": "Free to install",
        "monthly_cost": "Free to install"
      }
    ],
    "description": "Sell more with email, SMS, rewards programs, recommendations",
    "installs": 3826,
    "platform": "shopify",
    "vendor_name": "Marsello",
    "vendor_url": "https://apps.shopify.com/partners/recovermycart",
    "vendor_email": "help@marsello.com",
    "review_count": 303,
    "average_rating": "4.5",
    "icon_url": "https://apps.shopifycdn.com/listing_images/01610b7070e1a444e4229cbef477e025/icon/573fd08d59e91ed2680ee1e390f76802.png?height=84\u0026width=84",
    "state": "Active",
    "created_at": "2018-10-30T00:00:00"
  }
}

List Apps

Returns a list of Apps. By default, 50 Apps are returned in a single request. Use the page request option can be used to paginate.

Request Options
f:categories

Filters the results to Apps that belong to the provided categories. Multiple categories must be comma-separated.

f:categories:op

The boolean operation to apply to values provided in the f:categories request option (if multiple values are provided).

Possible values:

  • and (default): Returns Apps matching all provided values.
  • or: Returns Apps matching any provided value.
  • not: Returns Apps that do not match any of the provided values.

f:icmin

Filters the results to Apps with install counts greater than or equal to the provided integer value.

f:icmax

Filters the results to Apps with install counts than or equal to the provided integer value.

f:p

Filters the results to Apps on the given e-commerce platform. Multiple values must be comma-separated.

Valid values are:

  • woocommerce
  • shopify
  • wix
  • prestashop
  • magento
  • bigcartel
  • square
  • ecwid
  • bigcommerce
  • squarespace
  • volusion
  • 3dcart
  • lightspeed
  • demandware
  • webflow
  • spreecommerce
  • expandcart
  • miva
  • shopware
  • atg
  • ecomz
  • salla
  • oracle
  • zid

f:p:op

The boolean operation to apply to values provided in the f:p request option (if multiple values are provided).

Possible values:

  • and (default): Returns Apps matching all provided values.
  • or: Returns Apps matching any provided value.
  • not: Returns Apps that do not match any of the provided values.

f:rcmin

Filters the results to Apps with review counts greater than or equal to the provided integer value.

f:rcmax

Filters the results to Apps with review counts than or equal to the provided integer value.

fields

A comma-separated list of fields to include in the response. All fields are returned if left blank. If you only need a subset of fields in the response, it is recommended to use this request parameter since it can have a significant impact on response time.

Nested fields can be specified using a period to separate the field name and the nested field name. For instance, using fields=name,plans.name would return the name field from each App and the name field for all plans on each App.

page

The page of results to return. Default: 0.

page_size

The number of Apps to return in a single query. Default: 50, Max: 50.

sort

Changes the sort order. Multiple sort fields can be provided (comma-separated). Prefix fields with a minus sign (-) to denote descending sort order.

Valid fields are:

  • average_rating
  • created_at
  • installs
  • removed_at
  • reviews

Example Request

$ curl -H 'Authorization: Bearer your.api.key' 'https://storeleads.app/json/api/v1/all/app?page_size=2&f:p=shopify&f:categories=marketing'

Search requests can also be triggered via HTTP POST.

$ curl -H 'Authorization: Bearer your.api.key' -H "Content-Type: application/json" -X POST -d '{"page_size":2,"f:p":"shopify","f:categories":"marketing"}' 'https://storeleads.app/json/api/v1/all/app'

Example Response

{
  "apps": [
    {
      "id": "1.privy",
      "token": "privy",
      "name": "Privy ‑ Pop Ups, Email, \u0026 SMS",
      "categories": [
        "store design",
        "marketing",
        "sales and conversion optimization"
      ],
      "app_store_url": "https://apps.shopify.com/privy",
      "plans": [
        {
          "name": "Free",
          "monthly_cost": "Free to install"
        },
        {
          "name": "Privy Convert",
          "monthly_cost": "$20/month",
          "monthly_cost_cents": 2000
        },
        {
          "name": "Privy Email",
          "monthly_cost": "$13/month",
          "monthly_cost_cents": 1300
        },
        {
          "name": "Privy Text",
          "monthly_cost": "$10/month",
          "monthly_cost_cents": 1000
        }
      ],
      "description": "Exit Pop Ups, Email Marketing, Text, Upsell \u0026 Cart Recovery",
      "installs": 82468,
      "platform": "shopify",
      "vendor_name": "Privy",
      "vendor_url": "https://apps.shopify.com/partners/privy",
      "vendor_email": "support@privy.com",
      "review_count": 24386,
      "average_rating": "4.6",
      "icon_url": "https://apps.shopifycdn.com/listing_images/f3d61c764a54b22aed51cd1cc31b5a74/icon/620368ed2c537a42eaa1dc82593622e3.png?height=84\u0026width=84",
      "state": "Active",
      "created_at": "2018-10-30T00:00:00"
    },
    {
      "id": "1.free-shipping-bar",
      "token": "free-shipping-bar",
      "name": "Free Shipping Bar",
      "categories": [
        "store design",
        "marketing",
        "sales and conversion optimization"
      ],
      "app_store_url": "https://apps.shopify.com/free-shipping-bar",
      "plans": [
        {
          "name": "Basic Plan",
          "monthly_cost": "Free"
        },
        {
          "name": "Premium Plan",
          "monthly_cost": "$9.99/month",
          "monthly_cost_cents": 999
        }
      ],
      "description": "Free shipping bar with updated cart goal to boost order value",
      "installs": 23544,
      "platform": "shopify",
      "vendor_name": "Hextom",
      "vendor_url": "https://apps.shopify.com/partners/hextom",
      "vendor_email": "help@hextom.com",
      "review_count": 9778,
      "average_rating": "4.9",
      "icon_url": "https://apps.shopifycdn.com/listing_images/635cce572624d1086ac37403cf25b5ee/icon/390b8ec270438793fd37f05da12ee6bb.png?height=84\u0026width=84",
      "state": "Active",
      "created_at": "2018-10-30T00:00:00"
    }
  ]
}

Domains

Domain objects represent an online store identified by a DNS domain name. The API allows you to retrieve information for a domain based on its name.

The attributes of the Domain object are documented below.

aliases
List of alternate DNS domain names that refer to this Domain. Aliases are identified as other DNS domain names that point to the Domain through canonical links or redirects.
apps
List of Apps that the Domain has installed.
administrative_area_level_1
The administrative_area_level_1 of the Domain (if known). This value often represents the state/province of the associated merchant's headquarters.
avg_price

The average price of products sold on the Domain. Values in the minor unit of the Domain's currency (e.g., cents of USD).

categories
A list of the Domain's categories. Categories represent the Domain's industry vertical (e.g., "/Apparel/" or "/Beauty & Fitness/Face & Body Care")
city
The city of the Domain (if known). This value often represents the city of the associated merchant's headquarters.
contact_info

A list of contact information available for the Domain. This includes email addresses, phone numbers and social media accounts. The following attributes are included:

  • followers: number of followers (present only for twitter, instagram, facebook, pinterest and youtube handles)
  • followers_30d: change in number of followers over last 30 days
  • followers_90d: change in number of followers over last 90 days
  • source: relative url of the page that the contact information was found
  • type: the type of contact information (email, phone, twitter, facebook, instagram, pinterest, youtube, snapchat)
  • value: the contact information (email address, phone number or url to social network handle)

Note that some values may be redacted to comply with local privacy laws. See our Privacy Policy for more details.

country_code
The 2-letter ISO country code of the Domain. Note that a small percentage of Domains are not country-specific (they sell to multiple countries) and these Domains do not have a country-code.
created_at
The date at which the Domain was created. It is hard to know exactly when a store was created so this represents our best guess. For Domains created after July 2018, the creation date is based on when we first discovered the Domain, which tends to be very close to the actual creation date. For Domains created before July 2018, we use a heuristic that includes historic DNS and WHOIS data, which provides a reasonable approximation of domain creation time.
currency_code
The 3-letter ISO currency code of the Domain.
description
A text description of the Domain. Generally used to describe the goods and services provided by the merchant.
employee_count

The number of employees.

estimated_sales

The estimated total monthly sales for the merchant. Values in cents of USD.

features
A list of features enabled on the domain. e.g., ["Shopify Pay", "Apple Pay", "Apple Pay", "PayPal"]
inactive_at
The date at which the Domain became Inactive. Only set for Domains in Inactive state.
language_code
The 2-letter ISO 639-1 code for the language of content on the Domain's website. Value is blank is not known.
last_platform
The name of the e-commerce platform that the Domain previously used (if any). Note: Data not available for Domains that changed e-commerce platforms prior to October 2019.
last_platform_change_at

The date at which the Domain last changed e-commerce platforms (if any). Note: Data not available for Domains that changed e-commerce platforms prior to October 2019.

This field is only available on the Elite plan.

last_plan_change_at

The date at which the Domain last changed pricing plans (if any). Note: Data not available for Domains that changed plans prior to July 2019.

This field is only available on the Elite plan.

last_updated_at
The date at which data for the Domain was last updated.
latitude
The latitude of the Domain (if known). This value often represents the location of the associated merchant's headquarters.
longitude
The longitude of the Domain (if known). This value often represents the location of the associated merchant's headquarters.
magento_version
The version of Magento that the Domain uses (if known). Only applies to merchants on the Magento platform.
monthly_app_spend
The estimated amount the merchant spends on apps every month. Values in cents of USD.
location
The geographic location of the Domain (if known). This value is often the city/state of the associated merchant's headquarters.
merchant_name
The name of the merchant that is selling on the Domain.
name
The DNS domain name of the Domain.
plan
The name of the e-commerce platform's pricing plan that the merchant is using (if known). e.g., "Shopify Plus"
platform
The name of the e-commerce platform that powers the domain.
platform_rank
The rank of the Domain against all other Domains on the same e-commerce platforms. We rank e-commerce domains based on the popularity of each Domain (via traffic estimates) and the number and significance of links to each Domain.
product_count

The number of products sold by the Domain.

Product counts are precise for standard Shopify stores. For all other stores, product counts are an estimate.

rank
The "world-wide" rank of the Domain (across all supported e-commerce platforms). We rank all e-commerce domains based on the popularity of each Domain (via traffic estimates) and the number and significance of links to each Domain.
redirects_to
A list of domain names to which this Domain redirects. Only set on Domains in the Redirect state. This is an array since some Domains conditionally redirect to different locations (for instance, to redirect to one of many country-specific stores).
state
The state of the Domain. Can be one of the following values:
  • Active
  • Inactive
  • Password Protected
  • Redirect
technologies
Lists the third-party technologies installed on the Domain. Includes the following attributes:
  • name
  • description
tags
A list of tags associated with the Domain. Tags are automatically applied to Domains based on various attributes. Possible values:
  • Dropshipper
  • Print on Demand
  • Trending on Facebook
  • Trending on Instagram
  • Trending on Pinterest
  • Trending on TikTok
  • Trending on Twitter
  • Trending on YouTube
  • Dropping on Facebook
  • Dropping on Instagram
  • Dropping on Pinterest
  • Dropping on TikTok
  • Dropping on Twitter
  • Dropping on YouTube
theme
Describes the theme that the Domain is using. Includes the following attributes:
  • name
  • style
  • cost (in cents of USD)
  • vendor
  • version (for some themes only)
title
The value of the HTML title tag on the Domain's home page.
vendor_count

The number of distinct vendors of products sold by the Domain.

Vendor counts are only available for Shopify stores.

Retrieve a Domain

Retrieves the details of a Domain. You must provide the name of the Domain to lookup. The name can either be the public DNS domain name (e.g., merchant.com) or the provider domain (e.g., merchant.myshopify.com).

Example Request

$ curl -H 'Authorization: Bearer your.api.key' 'https://storeleads.app/json/api/v1/all/domain/www.vapes.com'

Example Response

{
  "domain": {
    "alexa_rank": 369886,
    "aliases": [
      "vapescom.myshopify.com"
    ],
    "apps": [
      {
        "id": "1.also-bought",
        "token": "also-bought",
        "name": "Also Bought • Cross Sell",
        "categories": [
          "sales and conversion optimization"
        ],
        "app_store_url": "https://apps.shopify.com/also-bought",
        "plans": [
          {
            "name": "$9.99/month",
            "monthly_cost": "$9.99/month",
            "monthly_cost_cents": 999
          }
        ],
        "description": "Best related product recommendations. Awarded Best App 2019",
        "installs": 6505,
        "installed_at": "2018-08-21T00:00:00Z",
        "platform": "shopify",
        "vendor_name": "Code Black Belt",
        "vendor_url": "https://apps.shopify.com/partners/codeblackbelt",
        "vendor_email": "support@codeblackbelt.com",
        "review_count": 603,
        "average_rating": "4.9",
        "icon_url": "https://apps.shopifycdn.com/listing_images/55a595d2413473dd0c6e6a315690886a/icon/d101da2a9943db5042ec669806ccb1a7.png?height=84\u0026width=84",
        "state": "Active",
        "created_at": "2018-10-30T00:00:00"
      },
      {
        "id": "1.back-in-stock",
        "token": "back-in-stock",
        "name": "Back In Stock: Customer Alerts",
        "categories": [
          "sales and conversion optimization",
          "orders and shipping",
          "inventory management"
        ],
        "app_store_url": "https://apps.shopify.com/back-in-stock",
        "plans": [
          {
            "name": "Free",
            "monthly_cost": "Free"
          },
          {
            "name": "Startup",
            "monthly_cost": "$19/month",
            "monthly_cost_cents": 1900
          },
          {
            "name": "Small Business",
            "monthly_cost": "$39/month",
            "monthly_cost_cents": 3900
          },
          {
            "name": "Medium Store",
            "monthly_cost": "$59/month",
            "monthly_cost_cents": 5900
          }
        ],
        "description": "Notify your customers when products are restocked: Email \u0026 SMS",
        "installs": 12744,
        "installed_at": "2018-08-21T00:00:00Z",
        "platform": "shopify",
        "vendor_name": "SureSwift Capital",
        "vendor_url": "https://apps.shopify.com/partners/wdh",
        "vendor_email": "support@backinstock.org",
        "review_count": 306,
        "average_rating": "4.9",
        "icon_url": "https://apps.shopifycdn.com/listing_images/08346a36a0a313120feec14003bedbc3/icon/49b8ec038ce4eb9d6f3516c63ca00385.png?height=84\u0026width=84",
        "state": "Active",
        "created_at": "2018-10-30T00:00:00"
      },
      {
        "id": "1.cm-commerce",
        "token": "cm-commerce",
        "name": "CM Commerce Email Marketing",
        "categories": [
          "store design",
          "marketing",
          "sales and conversion optimization"
        ],
        "app_store_url": "https://apps.shopify.com/cm-commerce",
        "plans": [
          {
            "name": "Free to install",
            "monthly_cost": "Free to install"
          }
        ],
        "description": "Email Marketing Automation, Reviews \u0026 Popups. (Prev Conversio)",
        "installs": 3579,
        "installed_at": "2020-04-06T00:00:00Z",
        "platform": "shopify",
        "vendor_name": "Campaign Monitor",
        "vendor_url": "https://apps.shopify.com/partners/receiptful",
        "vendor_email": "help.cmcommerce@campaignmonitor.com",
        "review_count": 1026,
        "average_rating": "4.7",
        "icon_url": "https://apps.shopifycdn.com/listing_images/05d3dad30666912ea0d52df60e35de42/icon/b70756bc82aafb33fa5a9d3bde3f2ba7.png?height=84\u0026width=84",
        "state": "Active",
        "created_at": "2019-10-02T00:00:00"
      },
      {
        "id": "1.generic-zotabox",
        "token": "generic-zotabox",
        "name": "Zotabox",
        "app_store_url": "https://apps.shopify.com/partners/zotabox",
        "description": "Boost Your Sales with 15 Free Marketing Tools",
        "installs": 20484,
        "installed_at": "2018-08-21T00:00:00Z",
        "platform": "shopify",
        "vendor_name": "Zotabox",
        "vendor_url": "https://info.zotabox.com/",
        "state": "Active",
        "created_at": "2018-11-01T00:00:00"
      },
      {
        "id": "1.mailchimp",
        "token": "mailchimp",
        "name": "Mailchimp",
        "categories": [
          "marketing"
        ],
        "app_store_url": "https://apps.shopify.com/mailchimp",
        "plans": [
          {
            "name": "Free",
            "monthly_cost": "Free"
          }
        ],
        "description": "The world’s largest marketing automation platform.",
        "installs": 151959,
        "installed_at": "2018-08-21T00:00:00Z",
        "platform": "shopify",
        "vendor_name": "Mailchimp",
        "vendor_url": "https://apps.shopify.com/partners/mailchimp",
        "vendor_email": "shopify@mailchimp.com",
        "review_count": 1147,
        "average_rating": "4.1",
        "icon_url": "https://apps.shopifycdn.com/listing_images/a06a73791138d8d7f2ef1d0d2c918e64/icon/3effee56b73b2af71488e18e74e25dd4.jpg?height=84\u0026quality=90\u0026width=84",
        "removed_at": "2019-03-23T12:35:26.883266184Z",
        "state": "Inactive",
        "created_at": "2018-10-30T00:00:00"
      },
      {
        "id": "1.marsello",
        "token": "marsello",
        "name": "Marsello",
        "categories": [
          "marketing"
        ],
        "app_store_url": "https://apps.shopify.com/marsello",
        "plans": [
          {
            "name": "Free to install",
            "monthly_cost": "Free to install"
          }
        ],
        "description": "Sell more with email, SMS, rewards programs, recommendations",
        "installs": 3826,
        "installed_at": "2019-04-09T00:00:00Z",
        "platform": "shopify",
        "vendor_name": "Marsello",
        "vendor_url": "https://apps.shopify.com/partners/recovermycart",
        "vendor_email": "help@marsello.com",
        "review_count": 303,
        "average_rating": "4.5",
        "icon_url": "https://apps.shopifycdn.com/listing_images/01610b7070e1a444e4229cbef477e025/icon/573fd08d59e91ed2680ee1e390f76802.png?height=84\u0026width=84",
        "state": "Active",
        "created_at": "2018-10-30T00:00:00"
      },
      {
        "id": "1.printful",
        "token": "printful",
        "name": "Printful: Print‑on‑Demand",
        "categories": [
          "finding and adding products"
        ],
        "app_store_url": "https://apps.shopify.com/printful",
        "plans": [
          {
            "name": "Free",
            "monthly_cost": "Free"
          }
        ],
        "description": "Top rated print-on-demand drop shipping \u0026 warehousing service",
        "installs": 95772,
        "installed_at": "2018-12-01T00:00:00Z",
        "platform": "shopify",
        "vendor_name": "Printful",
        "vendor_url": "https://apps.shopify.com/partners/jansons",
        "vendor_email": "support@printful.com",
        "review_count": 3091,
        "average_rating": "4.4",
        "icon_url": "https://apps.shopifycdn.com/listing_images/3dd87416a3b1e12a9ef3604aaaaf4d1e/icon/308fcea4e28961cc48a158efbdb38f3d.png?height=84\u0026width=84",
        "state": "Active",
        "created_at": "2018-10-30T00:00:00"
      },
      {
        "id": "1.printify",
        "token": "printify",
        "name": "Printify: Print on Demand",
        "categories": [
          "finding and adding products"
        ],
        "app_store_url": "https://apps.shopify.com/printify",
        "plans": [
          {
            "name": "Free",
            "monthly_cost": "Free"
          },
          {
            "name": "Premium",
            "monthly_cost": "$29/month",
            "monthly_cost_cents": 2900
          }
        ],
        "description": "Create and Sell Products, We Handle the Rest.",
        "installs": 25418,
        "installed_at": "2018-08-21T00:00:00Z",
        "platform": "shopify",
        "vendor_name": "Printify",
        "vendor_url": "https://apps.shopify.com/partners/printifyapp",
        "vendor_email": "merchantsupport@printify.com",
        "review_count": 1502,
        "average_rating": "4.3",
        "icon_url": "https://apps.shopifycdn.com/listing_images/64dbf028e50bc736072a16e7d0f8a382/icon/daeda97b8170ac247f5f20df3b27ae67.png?height=84\u0026width=84",
        "state": "Active",
        "created_at": "2018-10-30T00:00:00"
      },
      {
        "id": "1.product-reviews",
        "token": "product-reviews",
        "name": "Product Reviews",
        "categories": [
          "store design",
          "sales and conversion optimization"
        ],
        "app_store_url": "https://apps.shopify.com/product-reviews",
        "plans": [
          {
            "name": "Free",
            "monthly_cost": "Free"
          }
        ],
        "description": "The simplest way to share your customers' experiences.",
        "installs": 202693,
        "installed_at": "2018-08-21T00:00:00Z",
        "platform": "shopify",
        "vendor_name": "Shopify",
        "vendor_url": "https://apps.shopify.com/partners/shopify",
        "vendor_email": "support@shopify.com",
        "review_count": 1350,
        "average_rating": "3.9",
        "icon_url": "https://apps.shopifycdn.com/listing_images/60fca9c7f3400ddd43004e94b1355691/icon/a8f35d011cf83221b2ad1f280ff8d236.png?height=84\u0026width=84",
        "state": "Active",
        "created_at": "2018-10-30T00:00:00"
      },
      {
        "id": "1.product-reviews-addon",
        "token": "product-reviews-addon",
        "name": "Stamped.io Product Reviews UGC",
        "categories": [
          "store design",
          "sales and conversion optimization"
        ],
        "app_store_url": "https://apps.shopify.com/product-reviews-addon",
        "plans": [
          {
            "name": "Lite",
            "monthly_cost": "Free"
          },
          {
            "name": "Basic",
            "monthly_cost": "$19/month",
            "monthly_cost_cents": 1900
          },
          {
            "name": "Premium",
            "monthly_cost": "$39/month",
            "monthly_cost_cents": 3900
          },
          {
            "name": "Business",
            "monthly_cost": "$99/month",
            "monthly_cost_cents": 9900
          }
        ],
        "description": "Collect Product Reviews, Photos/Videos Reviews, Q\u0026A and UGC",
        "installs": 16582,
        "installed_at": "2018-08-21T00:00:00Z",
        "platform": "shopify",
        "vendor_name": "Stamped.io",
        "vendor_url": "https://apps.shopify.com/partners/shopry",
        "vendor_email": "hello@stamped.io",
        "review_count": 4198,
        "average_rating": "4.9",
        "icon_url": "https://apps.shopifycdn.com/listing_images/00f756e9e94e8c3cfb14266ae483d0f0/icon/a3db3cb9071a45f339f2e1f6370d1331.png?height=84\u0026width=84",
        "state": "Active",
        "created_at": "2018-10-30T00:00:00"
      },
      {
        "id": "1.stamped-io-loyalty-rewards",
        "token": "stamped-io-loyalty-rewards",
        "name": "Stamped.io Loyalty \u0026 Rewards",
        "categories": [
          "marketing"
        ],
        "app_store_url": "https://apps.shopify.com/stamped-io-loyalty-rewards",
        "plans": [
          {
            "name": "Lite",
            "monthly_cost": "Free"
          },
          {
            "name": "Premium",
            "monthly_cost": "$29/month",
            "monthly_cost_cents": 2900
          },
          {
            "name": "Business",
            "monthly_cost": "$99/month",
            "monthly_cost_cents": 9900
          },
          {
            "name": "Enterprise",
            "monthly_cost": "$399/month",
            "monthly_cost_cents": 39900
          }
        ],
        "description": "Increase Loyalty with a Successful Rewards Program",
        "installs": 21080,
        "installed_at": "2020-04-15T00:00:00Z",
        "platform": "shopify",
        "vendor_name": "Stamped.io",
        "vendor_url": "https://apps.shopify.com/partners/shopry",
        "vendor_email": "hello@stamped.io",
        "review_count": 28,
        "average_rating": "4.7",
        "icon_url": "https://apps.shopifycdn.com/listing_images/3e50e932c5ec0997c60cd4f3f0662bf7/icon/6297437a2b262b439aac585c00d14f62.png?height=84\u0026width=84",
        "state": "Active",
        "created_at": "2020-04-10T00:00:00"
      }
    ],
    "avg_price": 2674,
    "categories": [
      "/Smoking \u0026 Vaping"
    ],
    "country_code": "US",
    "currency_code": "USD",
    "employee_count": 17,
    "estimated_sales": 806754,
    "contact_info": [
      {
        "company": true,
        "followers": 16344,
        "followers_30d": -58,
        "followers_90d": -206,
        "source": "/",
        "type": "instagram",
        "value": "https://instagram.com/vapescom"
      },
      {
        "company": true,
        "source": "/",
        "type": "snapchat",
        "value": "https://www.snapchat.com/add/vapescom"
      },
      {
        "company": true,
        "followers": 35734,
        "followers_30d": -99,
        "followers_90d": -254,
        "source": "/pages/newsletter",
        "type": "facebook",
        "value": "https://facebook.com/vapescom"
      },
      {
        "company": true,
        "followers": 1369,
        "followers_30d": 16,
        "followers_90d": 31,
        "source": "/pages/newsletter",
        "type": "pinterest",
        "value": "https://www.pinterest.com/vapescom"
      },
      {
        "company": true,
        "followers": 528,
        "followers_90d": 4,
        "source": "/pages/newsletter",
        "type": "youtube",
        "value": "https://www.youtube.com/vapescom"
      },
      {
        "company": true,
        "source": "/pages/contact",
        "type": "phone",
        "value": "612-200-1962"
      },
      {
        "company": true,
        "source": "/pages/contact",
        "type": "phone",
        "value": "612-254-2649"
      },
      {
        "company": true,
        "source": "",
        "type": "linkedin",
        "value": "https://www.linkedin.com/company/vapes"
      }
    ],
    "language_code": "en",
    "last_plan_change_at": "2019-07-18T00:00:00",
    "latitude": 44.977753,
    "location": "Minneapolis, MN, USA",
    "city": "Minneapolis",
    "administrative_area_level_1": "Minnesota",
    "longitude": -93.2650108,
    "merchant_name": "VAPES E",
    "description": "Shop online for e-cigarettes, mods, vape pens, atomizers, dry herb vaporizers, oil/wax pens, enails, ehookah, accessories and USA made e-juice/liquid.",
    "monthly_app_spend": 999,
    "name": "www.vapes.com",
    "plan": "Shopify Plus",
    "platform_rank": 2733,
    "product_count": 1588,
    "platform": "shopify",
    "rank": 6200,
    "state": "Active",
    "tags": [
      "Dropshipper",
      "Print on Demand"
    ],
    "technologies": [
      {
        "name": "CM Commerce",
        "description": "CM Commerce takes the guesswork and time investment out of email marketing.",
        "installed_at": "2020-04-06T00:00:00Z"
      },
      {
        "name": "Google Analytics",
        "description": "Google Analytics gives you the tools you need to better understand your customers. You can then use those business insights to take action, such as improving your website, creating tailored audience lists, and more.",
        "installed_at": "2019-12-20T00:00:00Z"
      },
      {
        "name": "ShareASale",
        "description": "A leading provider of performance marketing solutions for the past 20 years.",
        "installed_at": "2020-09-30T00:00:00Z"
      }
    ],
    "theme": {
      "name": "debut",
      "style": "Light",
      "vendor": "Shopify",
      "version": "Unknown"
    },
    "title": "VAPES E-Cigs, E-juice, Wax Vape Pens, Herbal Vaporizers",
    "vendor_count": 222,
    "created_at": "2016-12-30T00:00:00",
    "last_updated_at": "2020-10-17T00:00:00"
  }
}

List Domains

Returns a list of Domains. The request options documented below can be used to constrain the results to Domains matching a specific criteria. Without any options, this endpoint will list all Domains.

By default, 50 Domains are returned in a single request. The cursor request option can be used to paginate through results.

Request Options
aq

Filters the results to Domains matching the Advanced Search.

cursor

The cursor request option is used to paginate through search results. Each response that has more results returns a next_cursor attribute. Pass this value to the cursor request option to retrieve the next page of results.

Note that the cursor value is only valid until the next weekly data update. An error will be returned if you obtain a cursor prior to a weekly data update and then attempt to use it after the weekly update.

Use cursor=all to retrieve all Domains matching the provided filters in a single request. This can also be done using the Export Domains endpoint (which is slightly faster) however you may prefer to use this endpoint so that all results are returned in a single JSON document.

When using cursor=all, results are generated asynchronously and the initial request will immediately return an HTTP 202 response. The client should poll the same url, approximately once every 5 seconds, until an HTTP 200 response is returned (along with results).

When an HTTP 202 response is returned, the response body may include keys indicating the progress of the export.

{ "progress": 10000, "total": 750000 }

f:an

Filters the results to Domains that have the given app installed. Apps are identified by combining the App platform and the App name (e.g., "shopify.messenger").

Multiple values must be comma-separated.

f:an:op

The boolean operation to apply to values provided in the f:an request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:administrative_area_level_1

Filters the results to Domains that are in the given administrative_area_level_1. Must be used with the f:cc filter.

Multiple values must be comma-separated. This field is mutually exclusive, so be sure to set f:administrative_area_level_1:op to "or" if you provide multiple values.

f:administrative_area_level_1:op

The boolean operation to apply to values provided in the f:administrative_area_level_1 request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:alexa_rank:min

Filters the results to Domains that have alexa_rank greater than or equal to the provided value.

f:alexa_rank:max

Filters the results to Domains that have alexa_rank less than or equal to the provided value.

f:app_installed_at

Filters the results to Domains that installed the given App identifier within time ranges specified by f:app_installed_at:min and f:app_installed_at:max (at least one of min and max must be provided).

f:app_installed_at:min

The minimum date for f:app_installed_at. If left blank, the response includes all Domains that installed the App before the provided maximum date (in f:app_installed_at:max).

f:app_installed_at:max

The maximum date for f:app_installed_at. If left blank, the response includes all Domains that installed the App after the provided minimum date (in f:app_installed_at:min).

f:app_uninstalled_at

Filters the results to Domains that uninstalled the given App identifier within time ranges specified by f:app_uninstalled_at:min and f:app_uninstalled_at:max (at least one of min and max must be provided).

f:app_uninstalled_at:min

The minimum date for f:app_uninstalled_at. If left blank, the response includes all Domains that uninstalled the App before the provided maximum date (in f:app_uninstalled_at:max).

f:app_uninstalled_at:max

The maximum date for f:app_uninstalled_at. If left blank, the response includes all Domains that uninstalled the App after the provided minimum date (in f:app_uninstalled_at:min).

f:avgppmin

Filters the results to Domains that have average product price greater than or equal to the provided integer value.

Note: this value is the minor unit of the Domain's currency (e.g., cents of USD). So use the value 150 to represent $1.50.

f:avgppmax

Filters the results to Domains that have average product price less than or equal to the provided integer value.

Note: this value is the minor unit of the Domain's currency (e.g., cents of USD). So use the value 150 to represent $1.50.

f:cat

Filters the results to Domains that have the given category.

Multiple values must be comma-separated.

f:cat:op

The boolean operation to apply to values provided in the f:cat request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:cc

Filters the results to Domains that are in the given country code.

Multiple values must be comma-separated. This field is mutually exclusive, so be sure to set f:cc:op to "or" if you provide multiple values.

f:cc:op

The boolean operation to apply to values provided in the f:cc request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:city

Filters the results to Domains that are in the given city. Must be used with the f:cc and f:administrative_area_level_1 filters.

Multiple values must be comma-separated. This field is mutually exclusive, so be sure to set f:city:op to "or" if you provide multiple values.

f:city:op

The boolean operation to apply to values provided in the f:city request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:cratyyyymm

Filters the results to Domains that were created in the given month (identified using YYYY-MM format).

Multiple values must be comma-separated. This field is mutually exclusive, so be sure to set f:cratyyyymm:op to "or" if you provide multiple values.

f:cratyyyymm:op

The boolean operation to apply to values provided in the f:cratyyyymm request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:cratyyyymmdd

Filters the results to Domains that were created in the given week (identified using YYYY-MM-DD format). Note that our data is updated weekly and the weekly creation date is always grouped to a Friday. If you query with a value that is not a Friday, we will automatically map the value provided to the previous Friday. (e.g., 2019-04-22 is be mapped to 2019-04-19).

Multiple values must be comma-separated. This field is mutually exclusive, so be sure to set f:cratyyyymmdd:op to "or" if you provide multiple values.

f:cratyyyymmdd:op

The boolean operation to apply to values provided in the f:cratyyyymmdd request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:curr

Filters the results to Domains selling with the given currency code.

Multiple values must be comma-separated. This field is mutually exclusive, so be sure to set f:curr:op to "or" if you provide multiple values.

f:curr:op

The boolean operation to apply to values provided in the f:curr request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:ds

Filters the results to Domains that are in the given state.

Valid values are:

  • Active
  • Inactive
  • Password Protected

Multiple values must be comma-separated. This field is mutually exclusive, so be sure to set f:ds:op to "or" if you provide multiple values.

f:ds:op

The boolean operation to apply to values provided in the f:ds request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:empcmin

Filters the results to Domains that have employee count greater than or equal to the provided integer value.

f:empcmax

Filters the results to Domains that have employee count less than or equal to the provided integer value.

f:ermin

Filters the results to Domains that have estimated monthly sales greater than or equal to the provided integer value.

Note: this value is in cents of USD. So use the value 150 to represent $1.50.

f:ermax

Filters the results to Domains that have estimated monthly sales less than or equal to the provided integer value.

Note: this value is in cents of USD. So use the value 150 to represent $1.50.

f:facebookfollowersmin

Filters the results to Domains that have a minimum number of Facebook followers.

f:facebookfollowersmax

Filters the results to Domains that have a maximum number of Facebook followers.

f:facebookfollowers30dmin

Filters the results to Domains that have added at least the given number of Facebook followers in the last 30 days. Note that values can be negative to find Domains that with shrinking follower counts.

f:facebookfollowers30dmax

Filters the results to Domains that have added at most the given number of Facebook followers in the last 30 days. Note that values can be negative to find Domains that with shrinking follower counts.

f:facebookfollowers30dpmin

Filters the results to Domains that have added at least the given percentage of Facebook followers in the last 30 days. Note that values can be negative to find Domains that with shrinking follower counts.

f:facebookfollowers30dpmax

Filters the results to Domains that have added at most the given percentage of Facebook followers in the last 30 days. Note that values can be negative to find Domains that with shrinking follower counts.

f:features

Filters the results to Domains that have the given features enabled.

Valid values are:

  • Amazon Pay
  • Apple Pay
  • Google Pay
  • PayPal
  • Shopify Pay

Multiple values must be comma-separated.

f:features:op

The boolean operation to apply to values provided in the f:features request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:instagramfollowersmin

Filters the results to Domains that have a minimum number of Instagram followers.

f:instagramfollowersmax

Filters the results to Domains that have a maximum number of Instagram followers.

f:instagramfollowers30dmin

Filters the results to Domains that have added at least the given number of Instagram followers in the last 30 days. Note that values can be negative to find Domains that with shrinking follower counts.

f:instagramfollowers30dmax

Filters the results to Domains that have added at most the given number of Instagram followers in the last 30 days. Note that values can be negative to find Domains that with shrinking follower counts.

f:instagramfollowers30dpmin

Filters the results to Domains that have added at least the given percentage of Instagram followers in the last 30 days. Note that values can be negative to find Domains that with shrinking follower counts.

f:instagramfollowers30dpmax

Filters the results to Domains that have added at most the given percentage of Instagram followers in the last 30 days. Note that values can be negative to find Domains that with shrinking follower counts.

f:ismy

Filters results based on Domain type. This is a boolean field. Use true to return only Domains using a provider domain name (e.g., merchant.myshopify.com). Use false to return only Domains using a custom domain (e.g., shop.merchant.com).

f:ismy:op

The boolean operation to apply to values provided in the f:ismy request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:it

Filters results to Domains that have contact information of the given type(s).

Valid values are:

  • email
  • facebook
  • instagram
  • phone
  • pinterest
  • snapchat
  • twitter
  • youtube

Multiple values must be comma-separated.

f:it:op

The boolean operation to apply to values provided in the f:it request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:lang

Filters the results to Domains with content in the given language code. (e.g., "en")

Multiple values must be comma-separated. This field is mutually exclusive, so be sure to set f:lang:op to "or" if you provide multiple values.

f:lang:op

The boolean operation to apply to values provided in the f:lang request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:last_plan_change_at:min

Filters the results to Domains that changed e-commerce platform pricing plans on or after the provided date. Often used with the f:plan request option.

f:last_plan_change_at:max

Filters the results to Domains that changed e-commerce platform pricing plans on or before the provided date. Often used with the f:plan request option.

f:last_platform

Filters the results to Domains that changed from the provided e-commerce platform.

Valid values are:

  • woocommerce
  • shopify
  • wix
  • prestashop
  • magento
  • bigcartel
  • square
  • ecwid
  • bigcommerce
  • squarespace
  • volusion
  • 3dcart
  • lightspeed
  • demandware
  • webflow
  • spreecommerce
  • expandcart
  • miva
  • shopware
  • atg
  • ecomz
  • salla
  • oracle
  • zid

Multiple values must be comma-separated. This field is mutually exclusive, so be sure to set f:p:op to "or" if you provide multiple values.

f:last_platform:op

The boolean operation to apply to values provided in the f:last_platform request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:last_platform_change_at:min

Filters the results to Domains that changed e-commerce platforms on or after the provided date.

f:last_platform_change_at:max

Filters the results to Domains that changed e-commerce platforms on or before the provided date.

f:masmin

Filters the results to Domains that have monthly app spend greater than or equal to the provided integer value.

Note: this value is in cents of USD. So use the value 150 to represent $1.50.

f:masmax

Filters the results to Domains that have monthly app spend less than or equal to the provided integer value.

Note: this value is in cents of USD. So use the value 150 to represent $1.50.

f:mmv

Filters the results to Domains that have given Magento major version.

Valid values are:

  • 1
  • 2

Multiple values must be comma-separated. This field is mutually exclusive, so be sure to set f:mmv:op to "or" if you provide multiple values.

Consider using the f:mv request option if you need to filter on the full Magento version.

f:mmv:op

The boolean operation to apply to values provided in the f:mmv request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:mv

Filters the results to Domains that have given Magento version.

Examples of valid values are:

  • 1.7.0.2
  • 2.3

Multiple values must be comma-separated. This field is mutually exclusive, so be sure to set f:mv:op to "or" if you provide multiple values.

Consider using the f:mmv request option if you only need to filter on the Magento major version.

f:mv:op

The boolean operation to apply to values provided in the f:mv request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:pinterestfollowersmin

Filters the results to Domains that have a minimum number of Pinterest followers.

f:pinterestfollowersmax

Filters the results to Domains that have a maximum number of Pinterest followers.

f:pinterestfollowers30dmin

Filters the results to Domains that have added at least the given number of Pinterest followers in the last 30 days. Note that values can be negative to find Domains that with shrinking follower counts.

f:pinterestfollowers30dmax

Filters the results to Domains that have added at most the given number of Pinterest followers in the last 30 days. Note that values can be negative to find Domains that with shrinking follower counts.

f:pinterestfollowers30dpmin

Filters the results to Domains that have added at least the given percentage of Pinterest followers in the last 30 days. Note that values can be negative to find Domains that with shrinking follower counts.

f:pinterestfollowers30dpmax

Filters the results to Domains that have added at most the given percentage of Pinterest followers in the last 30 days. Note that values can be negative to find Domains that with shrinking follower counts.

f:plan

Filters the results to Domains using the given pricing plan.

Examples of valid values are:

  • Shopify Plus
  • Professional
  • Performance
  • Premium

Multiple values must be comma-separated. This field is mutually exclusive, so be sure to set f:plan:op to "or" if you provide multiple values.

f:plan:op

The boolean operation to apply to values provided in the f:plan request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:p

Filters the results to Domains that are on the given e-commerce platform.

Valid values are:

  • woocommerce
  • shopify
  • wix
  • prestashop
  • magento
  • bigcartel
  • square
  • ecwid
  • bigcommerce
  • squarespace
  • volusion
  • 3dcart
  • lightspeed
  • demandware
  • webflow
  • spreecommerce
  • expandcart
  • miva
  • shopware
  • atg
  • ecomz
  • salla
  • oracle
  • zid

Multiple values must be comma-separated. This field is mutually exclusive, so be sure to set f:p:op to "or" if you provide multiple values.

f:p:op

The boolean operation to apply to values provided in the f:p request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:pcmin

Filters the results to Domains that have product count greater than or equal to the provided integer value.

f:pcmax

Filters the results to Domains that have product count less than or equal to the provided integer value.

f:prankmin

Filters the results to Domains that have platform rank greater than or equal to the provided integer value.

f:prankmax

Filters the results to Domains that have platform rank less than or equal to the provided integer value.

f:rankmin

Filters the results to Domains that have rank greater than or equal to the provided integer value.

f:rankmax

Filters the results to Domains that have rank less than or equal to the provided integer value.

f:reg

Filters the results to Domains that are in the given region (e.g., "Europe").

Multiple values must be comma-separated. This field is mutually exclusive, so be sure to set f:reg:op to "or" if you provide multiple values.

f:reg:op

The boolean operation to apply to values provided in the f:reg request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:sreg

Filters the results to Domains that are in the given subregion (e.g., "Northern Europe").

Multiple values must be comma-separated. This field is mutually exclusive, so be sure to set f:sreg:op to "or" if you provide multiple values.

f:sreg:op

The boolean operation to apply to values provided in the f:sreg request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:tags

Filters the results to Domains that have the given tags (e.g., "Print on Demand").

Multiple values must be comma-separated.

f:tags:op

The boolean operation to apply to values provided in the f:tags request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:tech

Filters the results to Domains that have the given technology installed (e.g., "Facebook Pixel").

Multiple values must be comma-separated.

f:tech:op

The boolean operation to apply to values provided in the f:tech request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:tech_installed_at

Filters the results to Domains that installed the given technology within time ranges specified by f:tech_installed_at:min and f:tech_installed_at:max (at least one of min and max must be provided).

f:tech_installed_at:min

The minimum date for f:tech_installed_at. If left blank, the response includes all Domains that installed the technology before the provided maximum date (in f:tech_installed_at:max).

f:tech_installed_at:max

The maximum date for f:tech_installed_at. If left blank, the response includes all Domains that installed the technology after the provided minimum date (in f:tech_installed_at:min).

f:tech_uninstalled_at

Filters the results to Domains that uninstalled the given technology within time ranges specified by f:tech_uninstalled_at:min and f:tech_uninstalled_at:max (at least one of min and max must be provided).

f:tech_uninstalled_at:min

The minimum date for f:tech_uninstalled_at. If left blank, the response includes all Domains that uninstalled the technology before the provided maximum date (in f:tech_uninstalled_at:max).

f:tech_uninstalled_at:max

The maximum date for f:tech_uninstalled_at. If left blank, the response includes all Domains that uninstalled the technology after the provided minimum date (in f:tech_uninstalled_at:min).

f:tld

Filters the results to Domains that are in the given top-level domain (e.g., "net").

Multiple values must be comma-separated. This field is mutually exclusive, so be sure to set f:tld:op to "or" if you provide multiple values.

f:tld:op

The boolean operation to apply to values provided in the f:tld request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:tn

Filters the results to Domains with the given Theme name.

Multiple values must be comma-separated. This field is mutually exclusive, so be sure to set f:tn:op to "or" if you provide multiple values.

f:tn:op

The boolean operation to apply to values provided in the f:tn request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:ts

Filters the results to Domains with the given Theme style.

Multiple values must be comma-separated. This field is mutually exclusive, so be sure to set f:ts:op to "or" if you provide multiple values.

f:ts:op

The boolean operation to apply to values provided in the f:ts request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:tvn

Filters the results to Domains with the given Theme vendor name.

Multiple values must be comma-separated. This field is mutually exclusive, so be sure to set f:tvn:op to "or" if you provide multiple values.

f:tvn:op

The boolean operation to apply to values provided in the f:tvn request option (if multiple values are provided).

Possible values:

  • and (default): Returns Domains matching all provided values.
  • or: Returns Domains matching any provided value.
  • not: Returns Domains that do not match any of the provided values.

For more complex queries, see Advanced Search.

f:twitterfollowersmin

Filters the results to Domains that have a minimum number of Twitter followers.

f:twitterfollowersmax

Filters the results to Domains that have a maximum number of Twitter followers.

f:twitterfollowers30dmin

Filters the results to Domains that have added at least the given number of Twitter followers in the last 30 days. Note that values can be negative to find Domains that with shrinking follower counts.

f:twitterfollowers30dmax

Filters the results to Domains that have added at most the given number of Twitter followers in the last 30 days. Note that values can be negative to find Domains that with shrinking follower counts.

f:twitterfollowers30dpmin

Filters the results to Domains that have added at least the given percentage of Twitter followers in the last 30 days. Note that values can be negative to find Domains that with shrinking follower counts.

f:twitterfollowers30dpmax

Filters the results to Domains that have added at most the given percentage of Twitter followers in the last 30 days. Note that values can be negative to find Domains that with shrinking follower counts.

f:youtubefollowersmin

Filters the results to Domains that have a minimum number of YouTube followers.

f:youtubefollowersmax

Filters the results to Domains that have a maximum number of YouTube followers.

f:youtubefollowers30dmin

Filters the results to Domains that have added at least the given number of YouTube followers in the last 30 days. Note that values can be negative to find Domains that with shrinking follower counts.

f:youtubefollowers30dmax

Filters the results to Domains that have added at most the given number of YouTube followers in the last 30 days. Note that values can be negative to find Domains that with shrinking follower counts.

f:youtubefollowers30dpmin

Filters the results to Domains that have added at least the given percentage of YouTube followers in the last 30 days. Note that values can be negative to find Domains that with shrinking follower counts.

f:youtubefollowers30dpmax

Filters the results to Domains that have added at most the given percentage of YouTube followers in the last 30 days. Note that values can be negative to find Domains that with shrinking follower counts.

fields

A comma-separated list of fields to include in the response. All fields are returned if left blank. If you only need a subset of fields in the response, it is recommended to use this request parameter since it can have a significant impact on response time.

Nested fields can be specified using a period to separate the field name and the nested field name. For instance, using fields=name,apps.name would return the name field from each Domain and the name field for all apps on each Domain.

page_size

The number of Domains to return in a single query. Default: 50, Max: 5000.

sort

Changes the sort order. Multiple fields can be provided (comma-separated). Prefix fields with a minus sign (-) to denote descending sort order.

Valid fields are:

  • app_install_count
  • average_product_price
  • created_at
  • estimated_sales
  • facebook_followers
  • instagram_followers
  • monthly_app_spend
  • pinterest_followers
  • product_count
  • theme_cost
  • twitter_followers

q

Filters Domains based on a text query. (e.g., a query for "vape" will return only Domains that matching the word "vape" in the Domain name, merchant_name or description fields).

Example Request

$ curl -H 'Authorization: Bearer your.api.key' 'https://storeleads.app/json/api/v1/all/domain?f:cc=US&f:cratyyyymm=2018-11&page_size=2'

Search requests can also be triggered via HTTP POST.

$ curl -H 'Authorization: Bearer your.api.key' -H "Content-Type: application/json" -X POST -d '{"page_size":2,"f:cc":"US","f:cratyyyymm":"2018-11"}' 'https://storeleads.app/json/api/v1/all/domain'

Example Response

{
  "domains": [
    {
      "alexa_rank": 84249,
      "aliases": [
        "www.shopcuup.com"
      ],
      "apps": [
        {
          "id": "1.foursixty",
          "token": "foursixty",
          "name": "Shoppable Instagram \u0026 UGC.",
          "categories": [
            "store design",
            "sales and conversion optimization"
          ],
          "app_store_url": "https://apps.shopify.com/foursixty",
          "plans": [
            {
              "name": "Core",
              "monthly_cost": "$50/month",
              "monthly_cost_cents": 5000
            },
            {
              "name": "Complete",
              "monthly_cost": "$300/month",
              "monthly_cost_cents": 30000
            }
          ],
          "description": "Shoppable Instagram \u0026 UGC. Rights Mgmt. Influencer Tracking.",
          "installs": 2277,
          "installed_at": "2020-03-07T00:00:00Z",
          "platform": "shopify",
          "vendor_name": "Foursixty",
          "vendor_url": "https://apps.shopify.com/partners/foursixty",
          "vendor_email": "helpme@foursixty.com",
          "review_count": 138,
          "average_rating": "4.6",
          "icon_url": "https://apps.shopifycdn.com/listing_images/43b401d6bc9caa05ff0f555ee2643f79/icon/454faebee6adeabe0bbac56b3b736081.jpg?height=84\u0026quality=90\u0026width=84",
          "state": "Active",
          "created_at": "2018-10-30T00:00:00"
        },
        {
          "id": "1.klaviyo-email-marketing",
          "token": "klaviyo-email-marketing",
          "name": "Klaviyo: Email Marketing",
          "categories": [
            "store design",
            "marketing"
          ],
          "app_store_url": "https://apps.shopify.com/klaviyo-email-marketing",
          "plans": [
            {
              "name": "Free to install",
              "monthly_cost": "Free to install"
            }
          ],
          "description": "Marketing software built for your growth",
          "installs": 120479,
          "installed_at": "2019-12-27T00:00:00Z",
          "platform": "shopify",
          "vendor_name": "Klaviyo",
          "vendor_url": "https://apps.shopify.com/partners/klaviyo",
          "vendor_email": "success@klaviyo.com",
          "review_count": 1075,
          "average_rating": "4.3",
          "icon_url": "https://apps.shopifycdn.com/listing_images/5edd9000b933a8fa88c152d1e498531f/icon/a4b94ea6ea6b897985ca70d45b2af29f.jpg?height=84\u0026quality=90\u0026width=84",
          "state": "Active",
          "created_at": "2018-10-30T00:00:00"
        },
        {
          "id": "1.shogun",
          "token": "shogun",
          "name": "Shogun Landing Page Builder",
          "categories": [
            "store design",
            "marketing"
          ],
          "app_store_url": "https://apps.shopify.com/shogun",
          "plans": [
            {
              "name": "Build",
              "monthly_cost": "$39/month",
              "monthly_cost_cents": 3900
            },
            {
              "name": "Measure",
              "monthly_cost": "$99/month",
              "monthly_cost_cents": 9900
            },
            {
              "name": "Optimize",
              "monthly_cost": "$149/month",
              "monthly_cost_cents": 14900
            }
          ],
          "description": "Build Custom Product Pages, Blog Posts, FAQ Pages \u0026 Funnels.",
          "installs": 23095,
          "installed_at": "2020-05-19T00:00:00Z",
          "platform": "shopify",
          "vendor_name": "Shogun Labs, Inc.",
          "vendor_url": "https://apps.shopify.com/partners/shogun",
          "vendor_email": "support@getshogun.com",
          "review_count": 2200,
          "average_rating": "4.8",
          "icon_url": "https://apps.shopifycdn.com/listing_images/0ca2c1526ec07b9f52021bd42651b1fd/icon/6ea8814365f9c5184a6e5dd4cc1d2e81.jpg?height=84\u0026quality=90\u0026width=84",
          "state": "Active",
          "created_at": "2018-10-30T00:00:00"
        },
        {
          "id": "1.yotpo-social-reviews",
          "token": "yotpo-social-reviews",
          "name": "Yotpo Product Reviews \u0026 Photos",
          "categories": [
            "store design",
            "marketing",
            "sales and conversion optimization"
          ],
          "app_store_url": "https://apps.shopify.com/yotpo-social-reviews",
          "plans": [
            {
              "name": "Free",
              "monthly_cost": "Free"
            },
            {
              "name": "Growth 50",
              "monthly_cost": "$19/month",
              "monthly_cost_cents": 1900
            },
            {
              "name": "Growth 75",
              "monthly_cost": "$29/month",
              "monthly_cost_cents": 2900
            },
            {
              "name": "Growth 100",
              "monthly_cost": "$49/month",
              "monthly_cost_cents": 4900
            }
          ],
          "description": "Collect product reviews, photo reviews, site reviews \u0026 ratings",
          "installs": 14114,
          "installed_at": "2018-11-02T00:00:00Z",
          "platform": "shopify",
          "vendor_name": "Yotpo",
          "vendor_url": "https://apps.shopify.com/partners/yotpo",
          "vendor_email": "shopify_support@yotpo.com",
          "review_count": 2312,
          "average_rating": "4.7",
          "icon_url": "https://apps.shopifycdn.com/listing_images/659062da3dcade1068da9e28c3d120c5/icon/a87575f0d7c6c417a374133a92c7db3d.png?height=84\u0026width=84",
          "state": "Active",
          "created_at": "2018-10-30T00:00:00"
        },
        {
          "id": "1.zendesk",
          "token": "zendesk",
          "name": "Zendesk Support",
          "categories": [
            "customer support"
          ],
          "app_store_url": "https://apps.shopify.com/zendesk",
          "plans": [
            {
              "name": "Free to install",
              "monthly_cost": "Free to install"
            }
          ],
          "description": "Omnichannel customer service and engagement platform",
          "installs": 6457,
          "installed_at": "2019-04-11T00:00:00Z",
          "platform": "shopify",
          "vendor_name": "Zendesk",
          "vendor_url": "https://apps.shopify.com/partners/zendesk_",
          "vendor_email": "support@zendesk.com",
          "review_count": 110,
          "average_rating": "3.1",
          "icon_url": "https://apps.shopifycdn.com/listing_images/d315fe70bcb98753afbe6aed7a9bffcd/icon/411bdcfb6c3c909e3ff99c2b01ef717b.png?height=84\u0026width=84",
          "state": "Active",
          "created_at": "2018-10-30T00:00:00"
        }
      ],
      "avg_price": 6247,
      "categories": [
        "/Apparel/Undergarments",
        "/Apparel/Women's Clothing"
      ],
      "country_code": "US",
      "currency_code": "USD",
      "employee_count": 18,
      "estimated_sales": 3199702,
      "features": [
        "Apple Pay",
        "PayPal",
        "Tracking or Returns"
      ],
      "contact_info": [
        {
          "company": true,
          "followers": 369,
          "followers_30d": 25,
          "followers_90d": 62,
          "source": "/",
          "type": "twitter",
          "value": "https://twitter.com/shopcuup"
        },
        {
          "company": true,
          "followers": 11448,
          "followers_30d": 745,
          "followers_90d": 2358,
          "source": "/",
          "type": "facebook",
          "value": "https://facebook.com/shopcuup"
        },
        {
          "company": true,
          "followers": 140729,
          "followers_30d": 9436,
          "followers_90d": 26805,
          "source": "/",
          "type": "instagram",
          "value": "https://instagram.com/cuup"
        },
        {
          "company": true,
          "followers": 3032,
          "followers_30d": 342,
          "followers_90d": 1191,
          "source": "/",
          "type": "pinterest",
          "value": "https://www.pinterest.com/shop_cuup"
        },
        {
          "company": true,
          "followers": 110,
          "followers_30d": 11,
          "followers_90d": 21,
          "source": "/",
          "type": "youtube",
          "value": "https://www.youtube.com/channel/UCs7jXtqALi--sOZ8n0aPNdw"
        },
        {
          "company": true,
          "source": "/products/the-demi-mesh-blush",
          "type": "email",
          "value": "support@shopcuup.com"
        },
        {
          "company": true,
          "source": "/pages/careers",
          "type": "email",
          "value": "careers@shopcuup.com"
        },
        {
          "company": true,
          "source": "/pages/contact-us",
          "type": "email",
          "value": "cuup@jenniferbett.com"
        },
        {
          "company": true,
          "source": "/pages/contact-us",
          "type": "email",
          "value": "marketing@shopcuup.com"
        },
        {
          "company": true,
          "source": "",
          "type": "linkedin",
          "value": "https://www.linkedin.com/company/cuupinc"
        }
      ],
      "language_code": "en",
      "last_plan_change_at": "2019-07-18T00:00:00",
      "latitude": 40.7127753,
      "location": "New York, NY, USA",
      "city": "New York",
      "administrative_area_level_1": "New York",
      "longitude": -74.0059728,
      "merchant_name": "CUUP",
      "description": "Shop Bras that look and feel great in every size. Made from breathable fabrics that support without losing comfort or looks - because your boobs deserve better!",
      "monthly_app_spend": 8900,
      "name": "shopcuup.com",
      "plan": "Shopify Plus",
      "platform_rank": 74,
      "product_count": 69,
      "platform": "shopify",
      "rank": 318,
      "state": "Active",
      "tags": [
        "Trending on Instagram",
        "Trending on Facebook"
      ],
      "technologies": [
        {
          "name": "Afterpay",
          "description": "Afterpay lets you buy what you want today, pay for it in four equal installments, interest-free.",
          "installed_at": "2019-12-20T00:00:00Z"
        },
        {
          "name": "Google Tag Manager",
          "description": "Google Tag Manager is a tag management system (TMS) that allows you to quickly and easily update tracking codes and related code fragments collectively known as tags on your website or mobile app.",
          "installed_at": "2019-12-20T00:00:00Z"
        },
        {
          "name": "Hotjar",
          "description": "Hotjar lets you see how visitors are really using your website, collect user feedback and turn more visitors into customers.",
          "installed_at": "2020-02-28T00:00:00Z"
        },
        {
          "name": "Klaviyo",
          "description": "Klaviyo is the growth marketing platform built for online businesses.",
          "installed_at": "2019-12-20T00:00:00Z"
        },
        {
          "name": "LinkShare",
          "description": "Discover new customers and increase conversions with the Rakuten LinkShare affiliate network.",
          "installed_at": "2020-10-02T00:00:00Z"
        },
        {
          "name": "Loop Returns",
          "description": "Loop is the returns solution built to help Shopify's top brands create lasting relationships.",
          "installed_at": "2020-09-03T00:00:00Z"
        },
        {
          "name": "Shogun",
          "description": "Build and optimize your pages with Shogun, the most powerful page building platform for eCommerce teams and agencies.",
          "installed_at": "2020-05-19T00:00:00Z"
        },
        {
          "name": "Talkable",
          "description": "Talkable is a referral program software for eCommerce brands. Acquire high-value clients at a low cost, increase retention and grow revenue through targeted referral and loyalty programs.",
          "installed_at": "2020-04-14T00:00:00Z"
        },
        {
          "name": "Yotpo",
          "description": "Yotpo accelerates growth with a full suite of solutions for customer reviews, visual marketing, loyalty programs, and referrals.",
          "installed_at": "2019-12-20T00:00:00Z"
        },
        {
          "name": "Zendesk",
          "description": "Zendesk customer service and engagement products are powerful and flexible, and scale to meet the needs of any business.",
          "installed_at": "2019-12-20T00:00:00Z"
        }
      ],
      "theme": {
        "name": "lucid 2020-08-27 quiz result [sh] - live",
        "style": "Unknown",
        "vendor": "Unknown",
        "version": "Unknown"
      },
      "title": "CUUP | Shop Bras and Underwear Made to Fit",
      "vendor_count": 1,
      "created_at": "2018-11-02T00:00:00",
      "last_updated_at": "2020-10-13T00:00:00"
    },
    {
      "alexa_rank": 1288,
      "country_code": "US",
      "estimated_sales": 710925,
      "contact_info": [
        {
          "company": true,
          "followers": 33622,
          "followers_30d": -7,
          "source": "/",
          "type": "twitter",
          "value": "https://twitter.com/SonyRewards"
        },
        {
          "company": true,
          "followers": 32280,
          "followers_90d": -110,
          "source": "/",
          "type": "facebook",
          "value": "https://www.facebook.com/SonyRewards"
        },
        {
          "company": true,
          "source": "/faqs.html",
          "type": "email",
          "value": "members@members.sonyrewards.com"
        },
        {
          "company": true,
          "source": "/faqs.html",
          "type": "phone",
          "value": "1.888.715.7669"
        },
        {
          "company": true,
          "source": "/terms.html",
          "type": "phone",
          "value": "201-930-6161"
        },
        {
          "company": true,
          "source": "/terms.html",
          "type": "phone",
          "value": "877-718-7669"
        },
        {
          "company": true,
          "source": "/privacy.html",
          "type": "phone",
          "value": "1-800-299-3485"
        },
        {
          "company": true,
          "source": "/privacy.html",
          "type": "phone",
          "value": "1-800-314-1552"
        }
      ],
      "language_code": "en",
      "latitude": 37.09024,
      "location": "United States",
      "longitude": -95.712891,
      "merchant_name": "Sony Rewards",
      "description": "A rewards program for those who love entertainment, whether it’s the latest games, movies or tech, our mission is simple. Elevate your experiences. Sony Rewards",
      "name": "www.rewards.sony.com",
      "platform_rank": 177,
      "product_count": 1028,
      "platform": "demandware",
      "rank": 517,
      "state": "Active",
      "technologies": [
        {
          "name": "CQuotient",
          "description": "CQuotient is a personalization solution enabling leading retailers to deliver uniquely tailored messages to every customer at any interaction. CQuotient was acquired by Demandware and is now part of Salesforce Commerce Cloud.",
          "installed_at": "2020-03-31T00:00:00Z"
        },
        {
          "name": "reCAPTCHA",
          "description": "reCAPTCHA is a free service that protects your website from spam and abuse. reCAPTCHA uses an advanced risk analysis engine and adaptive challenges to keep automated software from engaging in abusive activities on your site. It does this while letting your valid users pass through with ease.",
          "installed_at": "2020-03-23T00:00:00Z"
        }
      ],
      "theme": {
        "name": "Unknown",
        "style": "Unknown",
        "vendor": "Unknown",
        "version": "Unknown"
      },
      "title": "Sony Rewards",
      "created_at": "2018-11-09T00:00:00",
      "last_updated_at": "2020-10-12T00:00:00"
    }
  ],
  "next_cursor": "5b22205c753030303140405c6e5c75303030305c75303030305c75303030305c75303030305c75303030305c7530303030222c223135323330303134225d",
  "total": 22138
}

Advanced Search for Domains

Sometimes you'll need to filter Domains in a more complex manner than is supported by the various f: request options supported by List Domains.

Example: Complex text queries

As an example, let's say that you want to return all Shopify Domains that match the query "kids" and also match any of the following words: "footwear", "shoes" and "boots". Further, you want to filter out any results that match "ski" or "ballet" because you're not interested in that kind of kids footwear.

This complex search expression can be expressed using the aq request option (which is analogous to Advanced Search in the UI).

The aq request option takes an array of search descriptors. Each descriptor must provide the following values:

  • field: the name of the field
  • value: the value to query against (multiple values must be comma-separated)
  • operator: the operation to apply when multiple values are provided
    • and (default): Returns Domains matching all provided values
    • or: Returns Domains matching any of the provided values
    • nand: Returns Domains that do not match all of the provided values
    • nor: Returns Domains that do not match any of the provided values

Our example query would be represented as:

[ { "field": "q", "value": "kids"}, { "field": "q", "value": "footwear shoes boots", "operator": "or"}, { "field": "q", "value": "ski ballet", "operator": "nor"} ]

Example Request

The example advanced query above can be executed using the following HTTP POST.

$ curl -H 'Authorization: Bearer your.api.key' -H "Content-Type: application/json" -X POST -d '{"aq":[{"field":"q","value":"kids"},{"field":"q","value":"footwear shoes boots","operator":"or"},{ "field":"q","value":"ski ballet","operator":"nor"}]}' 'https://storeleads.app/json/api/v1/all/domain'

Filters expressed with the aq request option can be combined with other filter request options.

Supported Fields

Advanced queries can be run against the following fields.

avgpp
Average Product Price
an
Installed Apps
cat
Domain Categories
cc
Country Code
cfc
Combined Follower Count
city
City
curr
Currency Code
cratyyyymm
Created At YYYY-MM
cratyyyymmdd
Created At YYYY-MM-DD
ds
Status
empc
Employee Count
er
Estimated Revenue
ismy
Domain Type
it
Contact Information
mas
Monthly App Spend
p
Platform
pc
Products Sold
q
Query
rank
Rank
reg
Region
sreg
Subregion
state
State
tech
Technologies
tld
Top-level Domain
tn
Theme Name
ts
Theme Style
tvn
Theme Vendor Name

Export Domains

Returns all Domains matching the request options. Unlike List Domains, this endpoint does not paginate, instead it returns all Domains matching the query in a single response.

Note you may use the cursor request option of the List Domains endpoint (by passing cursor=all) to return all Domains matching a query. Unlike the Export Domains endpoint, The List Domains endpoint returns all results in a single JSON document (see below for details) and may be easier to use as a result. However, List Domains is much slower so Export Domains should be preferred where possible.

Request Options

Supports the same request options as List Domains.

Example Request

$ curl -H 'Authorization: Bearer your.api.key' 'https://storeleads.app/json/api/v1/all/domain-export?f:p=shopify&f:cc=US&f:cratyyyymm=2018-11'

Export requests can also be triggered via HTTP POST.

$ curl -H 'Authorization: Bearer your.api.key' -H "Content-Type: application/json" -X POST -d '{"f:cc":"US","f:cratyyyymm":"2018-11","f:p":"shopify"}' 'https://storeleads.app/json/api/v1/all/domain-export'

Example Response

The export endpoint streams the response as results are generated. Each line is a separate JSON document so be sure to parse the response one line at a time. The resulting domains are grouped into "chunks" which can arrived out-of-order. Each chunk includes an ordinal so that out-of-order results can be sorted if order is significant to your use case.

The first JSON document in the response contains meta information describing the response. It includes the following attributes:

domains
The total number of domains in the response. Domains are grouped into chunks.
chunk_size
The number of domains in each chunk.
expected_chunks
The total number of chunks in the response.

Subsequent documents contain the chunk ordinal and a list of domains within the chunk.

{ "chunk_size": 25000, "expected_chunks": 2, "domains": 29830 } { "chunk": 0, "domains": [ {"name": "thaikila.com", ... } ] } { "chunk": 1, "domains": [ {"name": "lidetailers.com", ... } ] }

Error Handling

Since the export endpoint is streamed, we cannot set the HTTP status code (which is set in the HTTP headers at the beginning on the response) when an error occurs in the middle of the stream. As a result, clients need additional error checking when using the export endpoint.

If an error occurs in the middle of a stream, a JSON document describing that error is written to the stream.

{ "chunk_size": 25000, "expected_chunks": 2, "domains": 29830 } { "chunk": 0, "domains": [ {"name": "thaikila.com", ... } ] } { "error": "error description" }

Clients should always verify that the response contained the expected number of chunks (by comparing the number of chunks received against the expected_chunks value in the meta JSON document).

Best Practices

Networks are unreliable and connections foten timeout if left open too long. To minimize the likelihood of networking errors, we suggest downloading the results of the export endpoint as quickly as possible. This means that you should do minimal processing of the results until the entire response has been read and persisted. Then, run whatever processing is necessary on the persisted results.


Products

Product objects represent a product for sale at a Domain.

List Products for a Domain

Returns a list of Products available for sale at a Domain.

Example Request

$ curl -H 'Authorization: Bearer your.api.key' 'https://storeleads.app/json/api/v1/all/product/domain/www.sensibo.com'

Example Response

{
  "products": [
    {
      "id": 3667330400308,
      "title": "Sensibo Inside",
      "handle": "sensibo-inside",
      "variants": [
        {
          "id": 28529519460404,
          "fulfillment_service": "manual",
          "option1": "Default Title",
          "position": 1,
          "price": "0.00",
          "requires_shipping": true,
          "taxable": true,
          "title": "Default Title",
          "created_at": "2019-05-12T10:18:26Z",
          "updated_at": "2019-05-12T10:18:26Z"
        }
      ],
      "vendor": "Sensibo",
      "published_scope": "web",
      "options": [
        {
          "name": "Title",
          "position": 1,
          "values": [
            "Default Title"
          ]
        }
      ],
      "published_at": "2019-05-12T10:18:05Z",
      "created_at": "2019-05-12T10:18:26Z",
      "updated_at": "2020-01-13T09:29:29Z"
    },
    {
      "id": 9353744974,
      "title": "Sensibo Sky",
      "handle": "sensibo-sky",
      "body_html": "\u003cmeta charset=\"utf-8\"\u003e\n\u003cp\u003eSensibo Sky is the ultimate solution to control your air conditioner from anywhere, anytime.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eGet comfortable \u0026amp; Save money:\u003c/strong\u003e\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003cspan\u003eInstallation takes \u003cstrong\u003eless than 2 min\u003c/strong\u003e, no drilling is required.\u003c/span\u003e\u003c/li\u003e\n\u003cli\u003e\u003cspan\u003eRemotely control multiple A/Cs using your phone.\u003c/span\u003e\u003c/li\u003e\n\u003cli\u003e\u003cspan\u003eCompatibility - Sensibo works with ANY remote controlled A/C.\u003c/span\u003e\u003c/li\u003e\n\u003cli\u003e\u003cspan\u003eCustomize your climate using Smart Scheduling, Timers and more.\u003c/span\u003e\u003c/li\u003e\n\u003cli\u003e\u003cspan\u003eSave money - Sensibo reduces your A/C costs by up to 40%.\u003c/span\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003e\u003cspan\u003eHave any questions? We'd be happy to assist you, \u003ca href=\"mailto:support@sensibo.com\" title=\"contact us\"\u003econtact us\u003c/a\u003e.\u003c/span\u003e\u003c/p\u003e",
      "variants": [
        {
          "id": 29008856252468,
          "fulfillment_service": "manual",
          "option1": "Single Kit",
          "option2": "1",
          "inventory_quantity": -1344,
          "position": 1,
          "price": "109.00",
          "requires_shipping": true,
          "sku": "SEN-SKY-01",
          "taxable": true,
          "title": "Single Kit / 1",
          "created_at": "2019-07-17T12:22:08Z",
          "updated_at": "2020-10-15T00:11:55Z"
        },
        {
          "id": 29008856285236,
          "fulfillment_service": "manual",
          "option1": "Starter Kit",
          "option2": "2",
          "inventory_quantity": -756,
          "position": 2,
          "price": "109.00",
          "requires_shipping": true,
          "sku": "SEN-SKY-01",
          "taxable": true,
          "title": "Starter Kit / 2",
          "created_at": "2019-07-17T12:22:08Z",
          "updated_at": "2020-10-15T00:16:15Z"
        },
        {
          "id": 29008856318004,
          "fulfillment_service": "manual",
          "option1": "Home Kit",
          "option2": "3",
          "inventory_quantity": -870,
          "position": 3,
          "price": "109.00",
          "requires_shipping": true,
          "sku": "SEN-SKY-01",
          "taxable": true,
          "title": "Home Kit / 3",
          "created_at": "2019-07-17T12:22:08Z",
          "updated_at": "2020-10-15T00:11:25Z"
        },
        {
          "id": 29008856350772,
          "fulfillment_service": "manual",
          "option1": "Family Kit",
          "option2": "4",
          "inventory_quantity": -741,
          "position": 4,
          "price": "109.00",
          "requires_shipping": true,
          "sku": "SEN-SKY-01",
          "taxable": true,
          "title": "Family Kit / 4",
          "created_at": "2019-07-17T12:22:08Z",
          "updated_at": "2020-10-14T22:42:15Z"
        }
      ],
      "vendor": "sensibo2",
      "published_scope": "web",
      "options": [
        {
          "name": "Title",
          "position": 1,
          "values": [
            "Single Kit",
            "Starter Kit",
            "Home Kit",
            "Family Kit"
          ]
        },
        {
          "name": "Quantity",
          "position": 2,
          "values": [
            "1",
            "2",
            "3",
            "4"
          ]
        }
      ],
      "images": [
        {
          "id": 14090684334132,
          "position": 1,
          "src": "https://cdn.shopify.com/s/files/1/1669/6891/products/Minimised-M16_132895-1a.jpg?v=1582817994",
          "created_at": null,
          "updated_at": null
        },
        {
          "id": 14090671587380,
          "position": 2,
          "src": "https://cdn.shopify.com/s/files/1/1669/6891/products/Minimised-M16_132856.jpg?v=1582817994",
          "created_at": null,
          "updated_at": null
        },
        {
          "id": 14090682695732,
          "position": 3,
          "src": "https://cdn.shopify.com/s/files/1/1669/6891/products/Minimised-M16_132895-1.jpg?v=1582817994",
          "created_at": null,
          "updated_at": null
        },
        {
          "id": 14090685087796,
          "position": 4,
          "src": "https://cdn.shopify.com/s/files/1/1669/6891/products/minimised-M16_132737-1.jpg?v=1582817994",
          "created_at": null,
          "updated_at": null
        },
        {
          "id": 14096226549812,
          "position": 5,
          "src": "https://cdn.shopify.com/s/files/1/1669/6891/products/WITB_0b4bbd26-bd96-47b4-8e2c-8c46bcd49982.png?v=1583054186",
          "created_at": null,
          "updated_at": null
        }
      ],
      "published_at": "2017-01-02T08:24:00Z",
      "created_at": "2017-01-02T08:45:22Z",
      "updated_at": "2020-10-15T00:20:02Z"
    },
    {
      "id": 1566786781236,
      "title": "Sensibo Sky",
      "handle": "sensibo-sky-white",
      "body_html": "\u003cmeta charset=\"utf-8\"\u003e\n\u003cp\u003eSensibo Sky is the ultimate solution to control your air conditioner from anywhere, anytime.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eGet comfortable \u0026amp; Save money:\u003c/strong\u003e\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003cspan\u003eInstallation takes \u003cstrong\u003eless than 2 min\u003c/strong\u003e, no drilling is required.\u003c/span\u003e\u003c/li\u003e\n\u003cli\u003e\u003cspan\u003eRemotely control multiple A/Cs using your phone.\u003c/span\u003e\u003c/li\u003e\n\u003cli\u003e\u003cspan\u003eCompatibility - Sensibo works with ANY remote controlled A/C.\u003c/span\u003e\u003c/li\u003e\n\u003cli\u003e\u003cspan\u003eCustomize your climate using Smart Scheduling, Timers and more.\u003c/span\u003e\u003c/li\u003e\n\u003cli\u003e\u003cspan\u003eSave money - Sensibo reduces your A/C costs by up to 40%.\u003c/span\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003e\u003cspan\u003eHave any questions? We'd be happy to assist you, \u003ca href=\"mailto:support@sensibo.com\" title=\"contact us\"\u003econtact us\u003c/a\u003e.\u003c/span\u003e\u003c/p\u003e",
      "variants": [
        {
          "id": 29008856416308,
          "fulfillment_service": "manual",
          "option1": "Single Kit",
          "option2": "1",
          "inventory_quantity": -6957,
          "position": 1,
          "price": "119.00",
          "requires_shipping": true,
          "sku": "SEN-SKY-01-WH",
          "taxable": true,
          "title": "Single Kit / 1",
          "created_at": "2019-07-17T12:22:12Z",
          "updated_at": "2020-10-14T23:35:20Z"
        },
        {
          "id": 29008856449076,
          "fulfillment_service": "manual",
          "option1": "Starter Kit",
          "option2": "2",
          "inventory_quantity": -4488,
          "position": 2,
          "price": "119.00",
          "requires_shipping": true,
          "sku": "SEN-SKY-01-WH",
          "taxable": true,
          "title": "Starter Kit / 2",
          "created_at": "2019-07-17T12:22:12Z",
          "updated_at": "2020-10-15T00:21:15Z"
        },
        {
          "id": 29008856481844,
          "fulfillment_service": "manual",
          "option1": "Home Kit",
          "option2": "3",
          "inventory_quantity": -7451,
          "position": 3,
          "price": "109.00",
          "requires_shipping": true,
          "sku": "SEN-SKY-01-WH",
          "taxable": true,
          "title": "Home Kit / 3",
          "created_at": "2019-07-17T12:22:12Z",
          "updated_at": "2020-10-14T22:42:10Z"
        },
        {
          "id": 29008856514612,
          "fulfillment_service": "manual",
          "option1": "Family Kit",
          "option2": "4",
          "inventory_quantity": -7081,
          "position": 4,
          "price": "109.00",
          "requires_shipping": true,
          "sku": "SEN-SKY-01-WH",
          "taxable": true,
          "title": "Family Kit / 4",
          "created_at": "2019-07-17T12:22:12Z",
          "updated_at": "2020-10-14T22:51:40Z"
        }
      ],
      "vendor": "sensibo2",
      "published_scope": "web",
      "options": [
        {
          "name": "Title",
          "position": 1,
          "values": [
            "Single Kit",
            "Starter Kit",
            "Home Kit",
            "Family Kit"
          ]
        },
        {
          "name": "Quantity",
          "position": 2,
          "values": [
            "1",
            "2",
            "3",
            "4"
          ]
        }
      ],
      "images": [
        {
          "id": 14096110551092,
          "position": 1,
          "src": "https://cdn.shopify.com/s/files/1/1669/6891/products/minimised-M16_128691-1a.jpg?v=1583048706",
          "created_at": null,
          "updated_at": null
        },
        {
          "id": 14096108552244,
          "position": 2,
          "src": "https://cdn.shopify.com/s/files/1/1669/6891/products/minimised-M16_128626.jpg?v=1583048706",
          "created_at": null,
          "updated_at": null
        },
        {
          "id": 14096109142068,
          "position": 3,
          "src": "https://cdn.shopify.com/s/files/1/1669/6891/products/minimised-M16_128691-1.jpg?v=1583048706",
          "created_at": null,
          "updated_at": null
        },
        {
          "id": 14096111665204,
          "position": 4,
          "src": "https://cdn.shopify.com/s/files/1/1669/6891/products/minimised-M16_132745-1.jpg?v=1583054159",
          "created_at": null,
          "updated_at": null
        },
        {
          "id": 14096222781492,
          "position": 5,
          "src": "https://cdn.shopify.com/s/files/1/1669/6891/products/WITB.png?v=1583054159",
          "created_at": null,
          "updated_at": null
        },
        {
          "id": 14077163864116,
          "position": 6,
          "src": "https://cdn.shopify.com/s/files/1/1669/6891/products/Web60-WEB-EN---BENEFIT-Works_with_voice_assistance_mobile.png?v=1583054159",
          "created_at": null,
          "updated_at": null
        },
        {
          "id": 14077163831348,
          "position": 7,
          "src": "https://cdn.shopify.com/s/files/1/1669/6891/products/Web60IT-Works_with_voice_assistance_mobile.png?v=1583054159",
          "created_at": null,
          "updated_at": null
        }
      ],
      "published_at": "2017-01-02T08:24:00Z",
      "created_at": "2019-02-11T10:51:53Z",
      "updated_at": "2020-10-15T00:21:15Z"
    }
  ],
  "total": 3
}


Tools

Postman

Postman is an app for easy RESTful API exploration and testing. You can use Postman to test API calls without having to write code.

To help get you started, you can review the Store Leads API in Postman. Then, follow the steps below to test the API interactively using the Postman app.

  1. If you don't already have it installed, visit https://www.getpostman.com/ and install the Postman client.
  2. Click the Run in Postman button below to open Postman and import the Store Leads API Postman collection.

Button

Swagger API Specification

The Store Leads API specification is available in Swagger/OpenAPI format.

Supported Languages

We haven't published any SDKs yet but the API specification can be used to automatically generate an SDK for a specific programming language. To do so, you'll need to have a working version of swagger-codegen installed and follow the instructions provided by swagger-codegen.

Webhooks

To be notified as soon as new data is added to the site (which happens weekly, normally on a Monday), you can configure webhooks under the Notifications tab of the Account page.