Store Leads
API Reference
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.
Authentication
Authenticate your account by including your API key in requests. If your account has access to the API, then you can generate an API key under the "API" tab of the Account page.
Note that API access is a paid feature so you'll need a paid account to continue..
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 ecommerce 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.
The time at which the App was installed by a Domain.
- Active
- Inactive (ie. removed from the App Store)
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": {
"average_rating": "4.6",
"app_store_url": "https://apps.shopify.com/marsello",
"state": "Active",
"free_trial_duration": "336h0m0s",
"description": "Increase sales with social media, email, SMS \u0026 loyalty rewards",
"icon_url": "https://cdn.shopify.com/app-store/listing_images/01610b7070e1a444e4229cbef477e025/icon/CIyfz7PIqfoCEAE=.png?height=60\u0026width=60",
"name": "Marsello: Email, SMS \u0026 Social",
"token": "marsello",
"platform": "shopify",
"vendor_name": "Marsello",
"vendor_url": "https://apps.shopify.com/partners/recovermycart",
"vendor_email": "help@marsello.com",
"vendor_website": "https://www.marsello.com/",
"id": "1.marsello",
"created_at": "2017-05-29T00:00:00",
"plans": [
{
"name": "Marsello Free",
"monthly_cost": "Free"
},
{
"name": "Marsello Pro",
"monthly_cost": "$100/month",
"monthly_cost_cents": 10000
}
],
"categories": [
"marketing and conversion",
"store management"
],
"integrates_with": [
"Vend",
"Google My Business",
"Lightspeed",
"Instagram",
"Facebook",
"TikTok"
],
"review_count": 343,
"installs": 3946
}
}
List Apps
Returns a list of Apps. By default, 50 Apps are returned in a single request. The page request option can be used to paginate.
Request Options
Filters the results to Apps that belong to the provided categories. Multiple categories must be comma-separated.
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.
Filters the results to Apps with install counts greater than or equal to the provided integer value.
Filters the results to Apps with install counts than or equal to the provided integer value.
Filters the results to Apps on the given ecommerce platform. Multiple values must be comma-separated.
Valid values are:
- woocommerce
- shopify
- custom
- wix
- squarespace
- cafe24
- prestashop
- square
- ecwid
- bigcartel
- godaddy
- magento
- opencart
- tiendanube
- bandcamp
- base
- basekit
- takeaway
- weeblycommerce
- bigcommerce
- lojaintegrada
- youcan
- prom
- spring
- mercado
- kajabi
- thinkific
- jouwweb
- shopline
- shopware
- shoptet
- tray
- odoo
- storesjp
- teachable
- shoper
- colormeshop
- menufy
- etsypattern
- salla
- teechip
- alibabaminisite
- epages
- imweb
- sapo
- shoplazza
- lnwshop
- cartx
- 3dcart
- yampi
- haravan
- makane
- nhngodo
- drupal
- ueeshop
- gambio
- shopyy
- ideasoft
- nop
- ticimax
- webflow
- volusion
- easystore
- sixshop
- makewebeasy
- empretienda
- vtex
- unas
- atg
- artstorefronts
- farmacieinitalia
- lightspeed
- shopbase
- oemsaas
- beatstars
- shoprenter
- unicart
- sage
- demandware
- satukz
- zid
- jtl
- hcl
- makeshop
- sap
- idosell
- aspdotnetstorefront
- quickbutik
- netsuite
- abicart
- xshoppy
- oxid
- rain
- gumroad
- cyberbiz
- neto
- cartzy
- dooca
- shopmatic
- commentsold
- plenty
- wizishop
- funpinpin
- sirclo
- dukaan
- spreadshop
- yahoo
- tokotalk
- boutir
- futureshop
- shopage
- qdm
- winedirect
- americommerce
- 91app
- spreecommerce
- merchantpro
- networksolutions
- expandcart
- smartetailing
- wbuy
- miva
- cityhive
- urastore
- irroba
- meepshop
- visualsoft
- wikinggruppen
- getshoptoday
- commerce7
- musicglue
- allvalue
- launchcart
- waca
- magazord
- vnda
- intershop
- cococart
- starweb
- fbits
- grazecart
- thehutgroup
- e37
- meshop
- coachannel
- bookmanager
- storeino
- askas
- ochre
- wuilt
- easymyshop
- microweber
- fastcommerce
- coachy
- vendre
- zammit
- ecomz
- bentoweb
- jet
- stackcommerce
- shopcada
- goimagine
- 82cart
- zvendo
- oracle
- commercehq
- linx
- storeberry
- moovin
- tossdown
- sprwt
- shopexpress
- sitecore
- deliverybizpro
- viskan
- matajer
- convertize
- shoptille
- elevar
- zyda
- commerceup
- norce
- workarea
- inovarti
- f1
- bleez
- tiu
- wx3
- stoom
- 2cshop
- ultracommerce
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.
Filters the results to Apps with review counts greater than or equal to the provided integer value.
Filters the results to Apps with review counts than or equal to the provided integer value.
A comma-separated list of fields to include in the response. All default 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.
The page of results to return. Default: 0.
The number of Apps to return in a single query. Default: 50, Max: 50.
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
Filters Apps based on a text query. (e.g., a query for "dropship" will return only Apps that matching the word "dropship" in the App name or description fields).
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": [
{
"average_rating": "4.9",
"app_store_url": "https://apps.shopify.com/push-notification-hero",
"state": "Active",
"description": "Abandoned Checkout w/Email, SMS, Push - Abandonment Protector",
"icon_url": "https://cdn.shopify.com/app-store/listing_images/4d5b689623cb3ec0ffa77973968c12ad/icon/CKCvs8PJ-fUCEAE=.png?height=60\u0026width=60",
"name": "Rivo Abandoned Cart Recovery",
"token": "push-notification-hero",
"platform": "shopify",
"vendor_name": "Rivo",
"vendor_url": "https://apps.shopify.com/partners/rivo",
"vendor_email": "help+recover@rivo.io",
"vendor_website": "https://www.rivo.io/",
"id": "1.push-notification-hero",
"created_at": "2019-12-10T00:00:00",
"plans": [
{
"name": "100% Free Forever",
"monthly_cost": "Free"
},
{
"name": "Starter",
"monthly_cost": "$15/month",
"monthly_cost_cents": 1500
},
{
"name": "Pro",
"monthly_cost": "$49/month",
"monthly_cost_cents": 4900
}
],
"categories": [
"store design",
"marketing",
"conversion"
],
"review_count": 2346,
"installs": 5557
},
{
"average_rating": "5.0",
"app_store_url": "https://apps.shopify.com/sendmunk",
"state": "Active",
"description": "Email \u0026 SMS Automations, Klaviyo, Privy, Mailchimp Alternative",
"icon_url": "https://cdn.shopify.com/app-store/listing_images/b3db1326bd13a3df8584c51d644559c1/icon/CJ_9m9v0lu8CEAE=.png?height=60\u0026width=60",
"name": "Email, Pop Up, Bar, Forms, SMS",
"token": "sendmunk",
"platform": "shopify",
"vendor_name": "Sendmunk",
"vendor_url": "https://apps.shopify.com/partners/sendmunk",
"vendor_email": "support@sendmunk.com",
"vendor_website": "https://sendmunk.com/",
"id": "1.sendmunk",
"created_at": "2021-01-05T00:00:00",
"plans": [
{
"name": "Free to install",
"monthly_cost": "Free to install"
}
],
"categories": [
"marketing",
"conversion",
"store management"
],
"review_count": 61
}
]
}
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, by searching for domains that match certain criteria or by exporting all domains.
The attributes of the Domain object are documented below.
The average price of products sold on the Domain. Values in the minor unit of the Domain's currency (e.g., cents of USD).
The average price of products sold on the Domain. Formatted in the store's currency. (e.g., $9.75)
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, facebook group, pinterest, tiktok 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, facebookgroup, instagram, pinterest, tiktok, yelp, youtube, snapchat, linkedin)
- 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.
The number of employees.
The estimated total monthly sales for the merchant. Values in cents of USD.
The date at which the Domain last changed ecommerce platforms (if any). Note: Data not available for Domains that changed ecommerce platforms prior to October 2019.
The name of the pricing plan that the Domain was previously on (if any). Note: Data not available for Domains that changed plans prior to July 2019.
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.
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.
- Active
- Inactive
- Password Protected
- Redirect
- 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
- name
- description
- name
- style
- cost (in cents of USD)
- vendor
- version (for some themes only)
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 platform domain (e.g., merchant.myshopify.com).
Example Request
$ curl -H 'Authorization: Bearer your.api.key' 'https://storeleads.app/json/api/v1/all/domain/goodasgoldshop.com'
Example Response
{
"domain": {
"theme": {
"name": "Unknown",
"style": "Unknown",
"vendor": "Unknown",
"version": "Unknown"
},
"cluster_best_ranked": "goodasgoldshop.com",
"city": "Wellington",
"last_updated_at": "2022-09-13T00:00:00",
"subregion": "Australia and New Zealand",
"contact_page": "https://goodasgoldshop.com/contact",
"country_code": "NZ",
"title": "Good as Gold - Streetwear, Fashion, Shoes \u0026 Accessories",
"administrative_area_level_1": "Wellington",
"state": "Active",
"icon": "https://goodasgoldshop.com/assets/favicons/apple-touch-icon.png",
"brands_page": "https://goodasgoldshop.com/brands",
"region": "Oceania",
"language_code": "en",
"tracking_page": "https://goodasgoldshop.com/shipping",
"last_platform_change_at": "2022-08-12T00:00:00",
"platform": "shopify",
"location": "Wellington, New Zealand",
"og_image": "https://goodasgoldshop.com/images/_400x400_crop_center-center_82/gagwelly01.jpg",
"merchant_name": "Good as Gold",
"last_platform": "custom",
"keywords": "streetwear,wellington,fashion,tshirt,nike,wallets,sneakers,footwear,watches,accessories,jewellery,outerwear,jackets,nz,new zealand,adidas,shoes,yu mei,veja,mens,womens,champion,dresses,handbags",
"created_at": "2018-06-15T00:00:00",
"name": "goodasgoldshop.com",
"description": "Description of the page less than 150 characters",
"contact_info": [
{
"category": "Women's Clothing Store",
"followers": 22595,
"followers_90d": -66,
"likes": 22725,
"source": "/",
"type": "facebook",
"value": "https://www.facebook.com/shopGoodAsGold"
},
{
"category": "Personal Goods \u0026 General Merchandise Stores",
"description": "EST. 2004 ~ Be Yourself 👍",
"followers": 27584,
"posts": 6858,
"source": "/",
"type": "instagram",
"value": "https://instagram.com/goodasgoldshop"
},
{
"description": "Good As Gold | Good as Gold is a family owned independent multi-brand fashion and streetwear store, bringing together the best brands from around the globe to present a unique curated selection of goodness. We hunt far and wide to bring you products of the highest quality, while providing the best service humanely possible.\n\nSince opening the doors in 2004, we have worked hard to create a hub for the creative community that surrounds us.\n\nGood Shit ~ Be Yourself",
"followers": 1988,
"followers_30d": -2,
"posts": 184,
"source": "/",
"type": "pinterest",
"value": "https://www.pinterest.nz/goodasgoldshop"
},
{
"source": "/",
"type": "phone",
"value": "+64 4 381 4653"
},
{
"source": "/contact",
"type": "phone",
"value": "+64 4 913 6061"
}
],
"aliases": [
"www.goodasgoldshop.com"
],
"categories": [
"/Apparel/Footwear"
],
"technologies": [
{
"installed_at": "2021-06-08T15:41:32Z",
"name": "Cloudflare CDN",
"description": "Protect and accelerate your websites, apps, and teams.",
"icon_url": "https://storeleads.app/img/tech/cloudflare.png",
"installs": 2578905
},
{
"installed_at": "2021-06-02T15:50:10Z",
"name": "Craft CMS",
"description": "Craft is a flexible, user-friendly CMS for creating custom digital experiences on the web and beyond.",
"icon_url": "https://storeleads.app/img/tech/craftcms.png",
"installs": 1075
},
{
"installed_at": "2022-09-06T10:15:05Z",
"name": "Facebook Pixel",
"description": "Facebook pixel is an analytics tool that consists of a code that can be placed on an online store to track site visitors. This data allows you to track effectiveness of advertising, retarget those users with Facebook ads in the future, as well as see what they’re doing on your site when they return.",
"icon_url": "https://storeleads.app/img/facebook.png",
"installs": 2411520
},
{
"installed_at": "2021-06-02T15:50:10Z",
"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.",
"icon_url": "https://storeleads.app/img/tech/ga.png",
"installs": 3434046
},
{
"installed_at": "2021-12-09T23:22:36Z",
"name": "Trustpilot",
"description": "Behind every review is an experience that matters.",
"icon_url": "https://storeleads.app/img/tech/trustpilot.png",
"installs": 91685
}
],
"cluster_domains": [
"goodasgoldshop.com",
"shop.goodasgoldshop.com"
],
"features": [
"Brands Page",
"International Shipping",
"Storefront API",
"Contact Page",
"Tracking or Returns",
"Tracking Page"
],
"rank_percentile": 0.6292,
"rank": 71714,
"latitude": -41.2864603,
"platform_rank_percentile": 0.7899,
"longitude": 174.776236,
"estimated_sales": 18944858,
"employee_count": 15,
"alexa_rank": 761527,
"cc_rank": 1988106,
"cc_centrality": 6595263,
"product_count": 2798,
"platform_rank": 17112
}
}
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
Filters the results to Domains matching the Advanced Search.
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. When you reach the end of the results, the response will not include a cursor.
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 }
When using cursor=all, responses are returned in the same format as all other requests to the "List Domains" endpoint. However, these responses can be quite large (often including data for million of domains). Since the default response format puts all data into a single JSON document, this can be challenging to parse. Unless you are using a streaming JSON parser, then all data in the response must fit into memory which may be challenging for development environments or smaller cloud instances. Add for=jsonl to the request options to change the output format to JSONL (which returns one JSON document per line) which is easier to parse.
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.
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.
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.
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.
Filters the results to Domains that have alexa_rank greater than or equal to the provided value.
Filters the results to Domains that have alexa_rank less than or equal to the provided value.
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).
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).
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).
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).
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).
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).
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.
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.
Filters the results to Domains that have the given category.
Multiple values must be comma-separated.
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.
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.
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.
Filters the results to Domains with a location 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.
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.
Filters the results to Domains that were created on or after the given time.
Filters the results to Domains that were created on or before the given time.
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.
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.
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.
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.
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.
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.
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.
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.
Filters the results to Domains that have employee count greater than or equal to the provided integer value.
Filters the results to Domains that have employee count less than or equal to the provided integer value.
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.
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.
Filters the results to Domains that have a minimum number of Facebook followers.
Filters the results to Domains that have a maximum number of Facebook followers.
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.
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.
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.
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.
Filters the results to Domains that have the given features enabled.
Valid values are:
- Brand Advocate Page
- Brands Page
- Contact Page
- Financing Page
- Free Returns
- Gift Messasging
- Has Android App
- Has iOS App
- International Shipping
- Public Company
- Returns Page
- Shopify POS
- Signature Required
- Store Locator Page
- Storefront API
- Tracking Page
- Tracking or Returns
- UPS Access Point
- Warranty Page
- Wholesale/Retailers Page
Multiple values must be comma-separated.
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.
Filters the results to Domains that have a minimum number of Instagram followers.
Filters the results to Domains that have a maximum number of Instagram followers.
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.
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.
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.
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.
Filters results based on Domain type. This is a boolean field. Use true to return only Domains using a platform domain name (e.g., merchant.myshopify.com). Use false to return only Domains using a custom domain (e.g., shop.merchant.com).
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.
Filters results to Domains that have contact information of the given type(s).
Valid values are:
- facebookgroup
- phone
- snapchat
- youtube
Multiple values must be comma-separated.
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.
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.
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.
Filters the results to Domains that changed ecommerce platform pricing plans on or after the provided date. Often used with the f:plan request option.
Filters the results to Domains that changed ecommerce platform pricing plans on or before the provided date. Often used with the f:plan request option.
Filters the results to Domains that changed from the provided ecommerce platform.
Valid values are:
- woocommerce
- shopify
- custom
- wix
- squarespace
- cafe24
- prestashop
- square
- ecwid
- bigcartel
- godaddy
- magento
- opencart
- tiendanube
- bandcamp
- base
- basekit
- takeaway
- weeblycommerce
- bigcommerce
- lojaintegrada
- youcan
- prom
- spring
- mercado
- kajabi
- thinkific
- jouwweb
- shopline
- shopware
- shoptet
- tray
- odoo
- storesjp
- teachable
- shoper
- colormeshop
- menufy
- etsypattern
- salla
- teechip
- alibabaminisite
- epages
- imweb
- sapo
- shoplazza
- lnwshop
- cartx
- 3dcart
- yampi
- haravan
- makane
- nhngodo
- drupal
- ueeshop
- gambio
- shopyy
- ideasoft
- nop
- ticimax
- webflow
- volusion
- easystore
- sixshop
- makewebeasy
- empretienda
- vtex
- unas
- atg
- artstorefronts
- farmacieinitalia
- lightspeed
- shopbase
- oemsaas
- beatstars
- shoprenter
- unicart
- sage
- demandware
- satukz
- zid
- jtl
- hcl
- makeshop
- sap
- idosell
- aspdotnetstorefront
- quickbutik
- netsuite
- abicart
- xshoppy
- oxid
- rain
- gumroad
- cyberbiz
- neto
- cartzy
- dooca
- shopmatic
- commentsold
- plenty
- wizishop
- funpinpin
- sirclo
- dukaan
- spreadshop
- yahoo
- tokotalk
- boutir
- futureshop
- shopage
- qdm
- winedirect
- americommerce
- 91app
- spreecommerce
- merchantpro
- networksolutions
- expandcart
- smartetailing
- wbuy
- miva
- cityhive
- urastore
- irroba
- meepshop
- visualsoft
- wikinggruppen
- getshoptoday
- commerce7
- musicglue
- allvalue
- launchcart
- waca
- magazord
- vnda
- intershop
- cococart
- starweb
- fbits
- grazecart
- thehutgroup
- e37
- meshop
- coachannel
- bookmanager
- storeino
- askas
- ochre
- wuilt
- easymyshop
- microweber
- fastcommerce
- coachy
- vendre
- zammit
- ecomz
- bentoweb
- jet
- stackcommerce
- shopcada
- goimagine
- 82cart
- zvendo
- oracle
- commercehq
- linx
- storeberry
- moovin
- tossdown
- sprwt
- shopexpress
- sitecore
- deliverybizpro
- viskan
- matajer
- convertize
- shoptille
- elevar
- zyda
- commerceup
- norce
- workarea
- inovarti
- f1
- bleez
- tiu
- wx3
- stoom
- 2cshop
- ultracommerce
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.
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.
Filters the results to Domains that changed ecommerce platforms on or after the provided date.
Filters the results to Domains that changed ecommerce platforms on or before the provided date.
Filters results to Domains that are on the associated Lists.
Lists are identified by the ID of the List which can be found using one of the List endpoints.
Multiple values must be comma-separated.
The boolean operation to apply to values provided in the f:lids 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.
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.
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.
Filters the results to Domains whose most recently published product is equal to or after the provided date.
Filters the results to Domains whose most recently published product is equal to or before the provided date.
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.
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.
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.
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.
Filters the results to Domains that have a minimum number of Pinterest followers.
Filters the results to Domains that have a maximum number of Pinterest followers.
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.
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.
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.
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.
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.
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.
Filters the results to Domains that are on the given ecommerce platform.
Valid values are:
- woocommerce
- shopify
- custom
- wix
- squarespace
- cafe24
- prestashop
- square
- ecwid
- bigcartel
- godaddy
- magento
- opencart
- tiendanube
- bandcamp
- base
- basekit
- takeaway
- weeblycommerce
- bigcommerce
- lojaintegrada
- youcan
- prom
- spring
- mercado
- kajabi
- thinkific
- jouwweb
- shopline
- shopware
- shoptet
- tray
- odoo
- storesjp
- teachable
- shoper
- colormeshop
- menufy
- etsypattern
- salla
- teechip
- alibabaminisite
- epages
- imweb
- sapo
- shoplazza
- lnwshop
- cartx
- 3dcart
- yampi
- haravan
- makane
- nhngodo
- drupal
- ueeshop
- gambio
- shopyy
- ideasoft
- nop
- ticimax
- webflow
- volusion
- easystore
- sixshop
- makewebeasy
- empretienda
- vtex
- unas
- atg
- artstorefronts
- farmacieinitalia
- lightspeed
- shopbase
- oemsaas
- beatstars
- shoprenter
- unicart
- sage
- demandware
- satukz
- zid
- jtl
- hcl
- makeshop
- sap
- idosell
- aspdotnetstorefront
- quickbutik
- netsuite
- abicart
- xshoppy
- oxid
- rain
- gumroad
- cyberbiz
- neto
- cartzy
- dooca
- shopmatic
- commentsold
- plenty
- wizishop
- funpinpin
- sirclo
- dukaan
- spreadshop
- yahoo
- tokotalk
- boutir
- futureshop
- shopage
- qdm
- winedirect
- americommerce
- 91app
- spreecommerce
- merchantpro
- networksolutions
- expandcart
- smartetailing
- wbuy
- miva
- cityhive
- urastore
- irroba
- meepshop
- visualsoft
- wikinggruppen
- getshoptoday
- commerce7
- musicglue
- allvalue
- launchcart
- waca
- magazord
- vnda
- intershop
- cococart
- starweb
- fbits
- grazecart
- thehutgroup
- e37
- meshop
- coachannel
- bookmanager
- storeino
- askas
- ochre
- wuilt
- easymyshop
- microweber
- fastcommerce
- coachy
- vendre
- zammit
- ecomz
- bentoweb
- jet
- stackcommerce
- shopcada
- goimagine
- 82cart
- zvendo
- oracle
- commercehq
- linx
- storeberry
- moovin
- tossdown
- sprwt
- shopexpress
- sitecore
- deliverybizpro
- viskan
- matajer
- convertize
- shoptille
- elevar
- zyda
- commerceup
- norce
- workarea
- inovarti
- f1
- bleez
- tiu
- wx3
- stoom
- 2cshop
- ultracommerce
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.
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.
Filters the results to Domains that have product count greater than or equal to the provided integer value.
Filters the results to Domains that have product count less than or equal to the provided integer value.
Filters the results to Domains that have platform rank greater than or equal to the provided integer value.
Filters the results to Domains that have platform rank less than or equal to the provided integer value.
Filters the results to Domains that have platform rank percentile greater than or equal to the provided float value.
Filters the results to Domains that have platform rank percentile less than or equal to the provided float value.
Filters the results to Domains that have rank greater than or equal to the provided integer value.
Filters the results to Domains that have rank less than or equal to the provided integer value.
Filters the results to Domains that have rank percentile greater than or equal to the provided float value.
Filters the results to Domains that have rank percentile less than or equal to the provided float value.
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.
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.
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.
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.
Filters the results to Domains that have the given tags (e.g., "Print on Demand").
Multiple values must be comma-separated.
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.
Filters the results to Domains that have the given technology installed (e.g., "Facebook Pixel").
Multiple values must be comma-separated.
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.
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).
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).
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).
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).
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).
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).
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.
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.
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.
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.
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.
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.
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.
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.
Filters the results to Domains that have a minimum number of Twitter followers.
Filters the results to Domains that have a maximum number of Twitter followers.
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.
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.
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.
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.
Filters the results to Domains that have a minimum number of YouTube followers.
Filters the results to Domains that have a maximum number of YouTube followers.
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.
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.
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.
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.
A comma-separated list of fields to include in the response. All default 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.
The number of Domains to return in a single query. Default: 50, Max: 5000.
Changes the sort order. Multiple fields can be provided (comma-separated). Prefix fields with a minus sign (-) to denote descending sort order.
Examples of valid fields are provided below. Note that each example uses "rank" as a secondary sort option. This is required to ensure consistent sort order when the value of the primary sort option is not unique (e.g., many stores have the same number of Facebook followers, so you need to specify a secondary sort option as a tie-breaker).
| arank,rank | Alexa Rank (Asc) |
| -arank,rank | Alexa Rank (Desc) |
| aic,rank | Apps Installed (Asc) |
| -aic,rank | Apps Installed (Desc) |
| avgpp,rank | Average Product Price (Asc) |
| -avgpp,rank | Average Product Price (Desc) |
| cfc,rank | Combined Followers (Asc) |
| -cfc,rank | Combined Followers (Desc) |
| cratyyyymmddnco,rank | Created (Asc) |
| -cratyyyymmddnco,rank | Created (Desc) |
| empc,rank | Employee Count (Asc) |
| -empc,rank | Employee Count (Desc) |
| er,rank | Estimated Sales (Asc) |
| -er,rank | Estimated Sales (Desc) |
| fc_2,rank | Facebook Followers (Asc) |
| -fc_2,rank | Facebook Followers (Desc) |
| fc30d_2,rank | Facebook Followers Last 30 Days (Asc) |
| -fc30d_2,rank | Facebook Followers Last 30 Days (Desc) |
| fc30dp_2,rank | Facebook Followers Last 30 Days Percent (Asc) |
| -fc30dp_2,rank | Facebook Followers Last 30 Days Percent (Desc) |
| fc_3,rank | Instagram Followers (Asc) |
| -fc_3,rank | Instagram Followers (Desc) |
| fc30d_3,rank | Instagram Followers Last 30 Days (Asc) |
| -fc30d_3,rank | Instagram Followers Last 30 Days (Desc) |
| fc30dp_3,rank | Instagram Followers Last 30 Days Percent (Asc) |
| -fc30dp_3,rank | Instagram Followers Last 30 Days Percent (Desc) |
| lplancat,rank | Last Plan Changed At (Asc) |
| -lplancat,rank | Last Plan Changed At (Desc) |
| maxpp,rank | Maximum Product Price (Asc) |
| -maxpp,rank | Maximum Product Price (Desc) |
| mas,rank | Monthly App Spend (Asc) |
| -mas,rank | Monthly App Spend (Desc) |
| fc_6,rank | Pinterest Followers (Asc) |
| -fc_6,rank | Pinterest Followers (Desc) |
| fc30d_6,rank | Pinterest Followers Last 30 Days (Asc) |
| -fc30d_6,rank | Pinterest Followers Last 30 Days (Desc) |
| fc30dp_6,rank | Pinterest Followers Last 30 Days Percent (Asc) |
| -fc30dp_6,rank | Pinterest Followers Last 30 Days Percent (Desc) |
| prank,rank | Platform Rank (Asc) |
| -prank,rank | Platform Rank (Desc) |
| pc,rank | Product Count (Asc) |
| -pc,rank | Product Count (Desc) |
| pic,rank | Product Image Count (Asc) |
| -pic,rank | Product Image Count (Desc) |
| rank | Rank (Asc) |
| -rank | Rank (Desc) |
| tc,rank | Theme Cost (Asc) |
| -tc,rank | Theme Cost (Desc) |
| fc_10,rank | TikTok Followers (Asc) |
| -fc_10,rank | TikTok Followers (Desc) |
| fc30d_10,rank | TikTok Followers Last 30 Days (Asc) |
| -fc30d_10,rank | TikTok Followers Last 30 Days (Desc) |
| fc30dp_10,rank | TikTok Followers Last 30 Days Percent (Asc) |
| -fc30dp_10,rank | TikTok Followers Last 30 Days Percent (Desc) |
| fc_1,rank | Twitter Followers (Asc) |
| -fc_1,rank | Twitter Followers (Desc) |
| fc30d_1,rank | Twitter Followers Last 30 Days (Asc) |
| -fc30d_1,rank | Twitter Followers Last 30 Days (Desc) |
| fc30dp_1,rank | Twitter Followers Last 30 Days Percent (Asc) |
| -fc30dp_1,rank | Twitter Followers Last 30 Days Percent (Desc) |
| fc_8,rank | YouTube Followers (Asc) |
| -fc_8,rank | YouTube Followers (Desc) |
| fc30d_8,rank | YouTube Followers Last 30 Days (Asc) |
| -fc30d_8,rank | YouTube Followers Last 30 Days (Desc) |
| fc30dp_8,rank | YouTube Followers Last 30 Days Percent (Asc) |
| -fc30dp_8,rank | YouTube Followers Last 30 Days Percent (Desc) |
Filters Domains based on a text query. e.g., a query for "vape" will return only Domains that matching the word "vape" in one of the following fields:
- Domain name (prefix match only)
- Domain top-level domain plus one (prefix match only)
- Domain aliases (prefix match only)
- Merchant name
- Home page title tag
- Home page meta description tag
- Home page meta keywords tag
- Technologies
- App names
- Location
- Social media account names
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": [
{
"theme": {
"name": "Unknown",
"style": "Unknown",
"vendor": "Unknown",
"version": "Unknown"
},
"alternates": {
"ar-AE": "mena.sunglasshut.com",
"ar-BH": "mena.sunglasshut.com",
"ar-EG": "mena.sunglasshut.com",
"ar-JO": "mena.sunglasshut.com",
"ar-KW": "mena.sunglasshut.com",
"ar-LB": "mena.sunglasshut.com",
"ar-MA": "mena.sunglasshut.com",
"ar-OM": "mena.sunglasshut.com",
"ar-QA": "mena.sunglasshut.com",
"ar-SA": "mena.sunglasshut.com",
"de-DE": "www.sunglasshut.com",
"en-AE": "mena.sunglasshut.com",
"en-AU": "www.sunglasshut.com",
"en-BH": "mena.sunglasshut.com",
"en-CA": "www.sunglasshut.com",
"en-EG": "mena.sunglasshut.com",
"en-GB": "www.sunglasshut.com",
"en-HK": "hk.sunglasshut.com",
"en-ID": "sea.sunglasshut.com",
"en-JO": "mena.sunglasshut.com",
"en-KW": "mena.sunglasshut.com",
"en-LB": "mena.sunglasshut.com",
"en-MA": "mena.sunglasshut.com",
"en-MY": "sea.sunglasshut.com",
"en-NZ": "www.sunglasshut.com",
"en-OM": "mena.sunglasshut.com",
"en-QA": "mena.sunglasshut.com",
"en-SA": "mena.sunglasshut.com",
"en-SG": "sea.sunglasshut.com",
"en-TH": "sea.sunglasshut.com",
"en-ZA": "za.sunglasshut.com",
"es-CL": "latam.sunglasshut.com",
"es-CO": "latam.sunglasshut.com",
"es-ES": "www.sunglasshut.com",
"es-MX": "www.sunglasshut.com",
"es-PE": "latam.sunglasshut.com",
"fr-CA": "www.sunglasshut.com",
"fr-FR": "www.sunglasshut.com",
"nl-NL": "nl.sunglasshut.com",
"pt-BR": "www.sunglasshut.com",
"pt-PT": "pt.sunglasshut.com",
"tr-TR": "tr.sunglasshut.com",
"x-default": "www.sunglasshut.com"
},
"cluster_best_ranked": "sunglasshut.com",
"last_updated_at": "2022-09-12T00:00:00",
"subregion": "Northern America",
"contact_page": "https://www.sunglasshut.com/us/sunglasses/contact-us",
"country_code": "US",
"currency_code": "USD",
"title": "Sunglass Hut® Online Store | Sunglasses for Women \u0026 Men",
"store_locator_page": "https://www.sunglasshut.com/us/sunglasses/store-locations?bookingAvailable=true",
"state": "Active",
"icon": "https://sunglasshut.com/wcsstore/MadisonsStorefrontAssetStore/images/touch-icon-180x180.png",
"brands_page": "https://sunglasshut.com/us/Sunglasses-Brands",
"returns_page": "https://sunglasshut.com/us/armani-exchange",
"region": "Americas",
"language_code": "en",
"tracking_page": "https://www.sunglasshut.com/us/shipping-delivery",
"platform": "hcl",
"location": "Milano IT",
"og_image": "https://www.sunglasshut.com/wcsstore/MadisonsStorefrontAssetStore/Attachment/sunglasshut-logo.png",
"merchant_name": "Sunglass Hut® Online Store",
"created_at": "2018-11-16T00:00:00",
"name": "sunglasshut.com",
"description": "Promotions available online! Shop the greatest selection of designer sunglasses choosing among the most stylish brands like Ray-Ban, Oakley and more.",
"contact_info": [
{
"description": "House of Sun since 1971",
"followers": 48541,
"followers_30d": 675,
"followers_90d": 2175,
"posts": 5946,
"source": "/",
"type": "twitter",
"value": "https://twitter.com/sunglasshut"
},
{
"followers": 2415685,
"followers_90d": 27,
"likes": 2423808,
"source": "/",
"type": "facebook",
"value": "https://www.facebook.com/Sunglass-Hut"
},
{
"followers": 2417476,
"followers_30d": 1543,
"followers_90d": 2225,
"likes": 2423701,
"source": "/",
"type": "facebook",
"value": "https://www.facebook.com/SunglassHut"
},
{
"category": "Food \u0026 Personal Goods",
"description": "House of Sun ☀️ since 1971 \n#FindEveryShadeOfYou",
"followers": 378271,
"followers_90d": 12618,
"posts": 2482,
"source": "/",
"type": "instagram",
"value": "https://instagram.com/sunglasshut"
},
{
"description": "Sunglass Hut | House of Sun since 1971",
"followers": 8477,
"followers_30d": 127,
"followers_90d": 474,
"posts": 725,
"source": "/",
"type": "pinterest",
"value": "https://www.pinterest.com/sunglasshut"
},
{
"source": "/",
"type": "linkedin",
"value": "https://www.linkedin.com/company/sunglasshut"
},
{
"followers": 4700,
"followers_90d": 341,
"source": "/",
"type": "tiktok",
"value": "https://www.tiktok.com/@sunglasshut"
}
],
"categories": [
"/Apparel/Eyewear"
],
"technologies": [
{
"installed_at": "2021-11-27T07:02:44Z",
"name": "Afterpay",
"description": "Afterpay lets you buy what you want today, pay for it in four equal installments, interest-free.",
"icon_url": "https://storeleads.app/img/tech/afterpay.png",
"installs": 353493
},
{
"installed_at": "2021-11-27T07:02:44Z",
"name": "Monetate",
"description": "Monetate offers complete optimization intelligence from hyper-personalization to A/B testing, and everything in between.",
"icon_url": "https://storeleads.app/img/tech/marketo.png",
"installs": 952
},
{
"installed_at": "2021-11-27T07:02:44Z",
"name": "Tealium",
"description": "Tealium connects data so you can connect with your customers.",
"icon_url": "https://storeleads.app/img/tech/tealium.png",
"installs": 59340
},
{
"installed_at": "2021-11-27T07:02:44Z",
"name": "Vimeo",
"description": "Vimeo provides simple tools for you and your team to create, manage and share high-quality videos.",
"icon_url": "https://storeleads.app/img/tech/vimeo.png",
"installs": 337546
}
],
"cluster_domains": [
"sunglasshut.com",
"apex.sunglasshut.com",
"ae.sunglasshut.com",
"sa.sunglasshut.com",
"kw.sunglasshut.com",
"www.sunglasshut.com.br",
"sunglasshut.com.bd",
"www.sunglasshut.com.de",
"www.sunglasshut.online"
],
"features": [
"Brands Page",
"Store Locator Page",
"Tracking Page",
"Contact Page",
"Returns Page",
"Free Returns",
"Tracking or Returns"
],
"shipping_carriers": [
"USPS"
],
"redirects_to": [
"www.sunglasshut.com"
],
"rank_percentile": 0.0061,
"rank": 692,
"platform_rank_percentile": 0.5631,
"estimated_sales": 43539948,
"employee_count": 4068,
"alexa_rank": 26428,
"cc_rank": 97053,
"cc_centrality": 87429,
"product_count": 4216,
"platform_rank": 22
},
{
"theme": {
"name": "Unknown",
"style": "Unknown",
"vendor": "Unknown",
"version": "Unknown"
},
"alternates": {
"ar": "www.westerndigital.com",
"ar-AE": "www.westerndigital.com",
"ar-DZ": "www.westerndigital.com",
"ar-EG": "www.westerndigital.com",
"ar-QA": "www.westerndigital.com",
"cs": "www.westerndigital.com",
"de": "www.westerndigital.com",
"de-AT": "www.westerndigital.com",
"el": "www.westerndigital.com",
"en": "www.westerndigital.com",
"en-AT": "www.westerndigital.com",
"en-AU": "www.westerndigital.com",
"en-BD": "www.westerndigital.com",
"en-BE": "www.westerndigital.com",
"en-BG": "www.westerndigital.com",
"en-BY": "www.westerndigital.com",
"en-CA": "www.westerndigital.com",
"en-DK": "www.westerndigital.com",
"en-EE": "www.westerndigital.com",
"en-FI": "www.westerndigital.com",
"en-GB": "www.westerndigital.com",
"en-HR": "www.westerndigital.com",
"en-HU": "www.westerndigital.com",
"en-IE": "www.westerndigital.com",
"en-IL": "www.westerndigital.com",
"en-IN": "www.westerndigital.com",
"en-LT": "www.westerndigital.com",
"en-LV": "www.westerndigital.com",
"en-MY": "www.westerndigital.com",
"en-NO": "www.westerndigital.com",
"en-NZ": "www.westerndigital.com",
"en-PH": "www.westerndigital.com",
"en-PT": "www.westerndigital.com",
"en-RO": "www.westerndigital.com",
"en-SE": "www.westerndigital.com",
"en-SG": "www.westerndigital.com",
"en-SI": "www.westerndigital.com",
"en-SK": "www.westerndigital.com",
"en-UA": "www.westerndigital.com",
"en-US": "www.westerndigital.com",
"en-VN": "www.westerndigital.com",
"es": "www.westerndigital.com",
"es-AR": "www.westerndigital.com",
"es-CL": "www.westerndigital.com",
"es-CO": "www.westerndigital.com",
"es-EC": "www.westerndigital.com",
"es-ES": "www.westerndigital.com",
"es-MX": "www.westerndigital.com",
"es-PE": "www.westerndigital.com",
"fr": "www.westerndigital.com",
"fr-CA": "www.westerndigital.com",
"in": "www.westerndigital.com",
"it": "www.westerndigital.com",
"ja": "www.westerndigital.com",
"ko": "www.westerndigital.com",
"nl": "www.westerndigital.com",
"pl": "www.westerndigital.com",
"pt": "www.westerndigital.com",
"ru": "www.westerndigital.com",
"th": "www.westerndigital.com",
"tr": "www.westerndigital.com",
"x-default": "www.westerndigital.com",
"zh": "www.westerndigital.com",
"zh-TW": "www.westerndigital.com"
},
"cluster_best_ranked": "www.westerndigital.com",
"city": "San Jose",
"last_updated_at": "2022-09-14T00:00:00",
"subregion": "Northern America",
"contact_page": "https://www.westerndigital.com/company/contact-us",
"country_code": "US",
"title": "High-Performance SSDs, HDDs, USB Drives, \u0026 Memory Cards | Western Digital",
"administrative_area_level_1": "California",
"state": "Active",
"icon": "https://www.westerndigital.com/content/dam/store/en-us/portal-assets/logos/shop-fav-icon.ico",
"financing_page": "https://www.westerndigital.com/company/programs/affirm-financing",
"region": "Americas",
"language_code": "en",
"platform": "custom",
"location": "San Jose, CA, USA",
"og_image": "https://www.westerndigital.com/content/dam/store/en-us/portal-assets/logos/WesternDigital-Open-Graph-Logo-1600x627-Clear-Spaced.png",
"merchant_name": "Western Digital",
"warranty_page": "https://www.westerndigital.com/company/programs/extended-warranty",
"created_at": "2018-11-02T00:00:00",
"name": "www.westerndigital.com",
"description": "Western Digital has the best Mac and PC compatible digital storage solutions plus FREE shipping, friendly customer support, and a 30 day return policy.",
"retailer_page": "https://www.westerndigital.com/company/distributors",
"contact_info": [
{
"description": "We create data storage solutions that power the technology of today and inspire the innovations of tomorrow. #WesternDigital\n\nNeed help? DM @WesternDigiCare.",
"followers": 161017,
"followers_30d": 2518,
"followers_90d": 13936,
"posts": 5070,
"source": "/",
"type": "twitter",
"value": "https://twitter.com/westerndigital"
},
{
"category": "Product/Service",
"followers": 217801,
"followers_30d": 13753,
"followers_90d": 49877,
"likes": 212760,
"source": "/",
"type": "facebook",
"value": "https://www.facebook.com/WesternDigitalCorporation"
},
{
"category": "Personal Goods \u0026 General Merchandise Stores",
"description": "We create data storage solutions that power the technology of today and inspire the innovations of tomorrow. #WesternDigital",
"followers": 14065,
"followers_90d": 1233,
"posts": 386,
"source": "/",
"type": "instagram",
"value": "https://www.instagram.com/westerndigital"
},
{
"source": "/",
"type": "phone",
"value": "855-493-7867"
},
{
"description": "Official Western Digital news and insights. Western Digital is driving the innovation needed to help customers capture, preserve, access and transform an eve...",
"followers": 10300,
"followers_90d": 259,
"source": "/",
"type": "youtube",
"value": "https://www.youtube.com/channel/UCQpijqbZeCM3zLew0ZwiX4A"
},
{
"source": "/",
"type": "linkedin",
"value": "https://www.linkedin.com/company/western-digital"
},
{
"source": "/privacy",
"type": "phone",
"value": "1-800-275-4932"
},
{
"source": "/company/programs/data-recovery/faq",
"type": "phone",
"value": "855-493-7687"
}
],
"aliases": [
"mcclean.org.uk"
],
"categories": [
"/Computers/Computer Hardware/Computer Drives \u0026 Storage"
],
"technologies": [
{
"installed_at": "2021-06-14T21:09:02Z",
"name": "Adobe Tag Manager",
"description": "Adobe Cloud Platform Launch makes it easy to manage tags",
"icon_url": "https://storeleads.app/img/tech/adobe.png",
"installs": 1080
},
{
"installed_at": "2021-11-02T21:04:41Z",
"name": "Affirm",
"description": "Affirm lets you shop stress-free at thousands of stores, with no late fees and no surprises. Just select Affirm at checkout.",
"icon_url": "https://storeleads.app/img/tech/affirm.png",
"installs": 8261
},
{
"installed_at": "2021-11-02T21:04:41Z",
"name": "Baazarvoice",
"description": "Connect shoppers with authentic content they trust.",
"icon_url": "https://storeleads.app/img/tech/bazaarvoice.png",
"installs": 4471
},
{
"installed_at": "2022-03-03T04:06:38Z",
"name": "Facebook Pixel",
"description": "Facebook pixel is an analytics tool that consists of a code that can be placed on an online store to track site visitors. This data allows you to track effectiveness of advertising, retarget those users with Facebook ads in the future, as well as see what they’re doing on your site when they return.",
"icon_url": "https://storeleads.app/img/facebook.png",
"installs": 2411520
},
{
"installed_at": "2020-05-24T13:10:35Z",
"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.",
"icon_url": "https://storeleads.app/img/tech/gtm.png",
"installs": 3127636
},
{
"installed_at": "2021-11-02T21:04:41Z",
"name": "Salesforce",
"description": "Salesforce provides customer relationship management service and also provides a complementary suite of enterprise applications focused on customer service, marketing automation, analytics, and application development.",
"icon_url": "https://storeleads.app/img/tech/salesforce.png",
"installs": 16264
},
{
"installed_at": "2022-03-03T04:06:38Z",
"name": "YouTube Player",
"description": "The YouTube Player lets you embed YouTube videos in your website or application.",
"icon_url": "https://storeleads.app/img/youtube.png",
"installs": 1097426
}
],
"cluster_domains": [
"www.westerndigital.com",
"print.westerndigital.com",
"preview.print.westerndigital.com"
],
"features": [
"Warranty Page",
"Contact Page",
"Financing Page",
"Wholesale/Retailers Page",
"Brand Advocate Page",
"Public Company"
],
"tags": [
"Trending on Facebook"
],
"rank_percentile": 0.0078,
"rank": 893,
"latitude": 37.3382082,
"platform_rank_percentile": 0.0442,
"longitude": -121.8863286,
"estimated_sales": 138943530,
"employee_count": 18730,
"alexa_rank": 4909,
"cc_rank": 13974,
"cc_centrality": 15616,
"product_count": 381,
"platform_rank": 634
}
],
"has_next_page": true,
"next_cursor": "5b22205c753030303140457a5c75303030305c75303030305c75303030305c75303030305c75303030305c7530303030222c223236323537323831225d",
"total": 19842
}
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.
- Merchant name
- Home page title tag
- Home page meta description tag
- Home page meta keywords tag
- Technologies
- App names
- Location
- Social media account names
List Domains By TLD1
Returns a list of Domains with the matching TLD1 (top-level-domain plus one). This is useful when you want to list all domains that share a top-level-domain plus one (e.g., all subdomains of "gymshark.com").
Request Options
A comma-separated list of fields to include in the response. All default 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.
Example Request
$ curl -H 'Authorization: Bearer your.api.key' 'https://storeleads.app/json/api/v1/all/domain/bytld1/gymshark.com?fields=name,language_code,state,rank'
Example Response
{
"domains": [
{
"state": "Active",
"language_code": "en",
"name": "www.gymshark.com",
"rank": 308
},
{
"state": "Active",
"language_code": "en",
"name": "uk.gymshark.com",
"rank": 819
},
{
"state": "Active",
"language_code": "en",
"name": "ca.gymshark.com",
"rank": 8429
},
{
"state": "Active",
"language_code": "en",
"name": "au.gymshark.com",
"rank": 8949
},
{
"state": "Active",
"language_code": "de",
"name": "de.gymshark.com",
"rank": 9813
},
{
"state": "Active",
"language_code": "nl",
"name": "nl.gymshark.com",
"rank": 10025
},
{
"state": "Active",
"language_code": "fr",
"name": "fr.gymshark.com",
"rank": 10302
},
{
"state": "Active",
"language_code": "en",
"name": "row.gymshark.com",
"rank": 22193
},
{
"state": "Active",
"language_code": "en",
"name": "fi.gymshark.com",
"rank": 46403
},
{
"state": "Active",
"language_code": "en",
"name": "se.gymshark.com",
"rank": 55256
},
{
"state": "Active",
"language_code": "de",
"name": "ch.gymshark.com",
"rank": 57549
},
{
"state": "Active",
"language_code": "en",
"name": "no.gymshark.com",
"rank": 57717
},
{
"state": "Active",
"language_code": "en",
"name": "dk.gymshark.com",
"rank": 62150
},
{
"state": "Active",
"language_code": "en",
"name": "eu.gymshark.com",
"rank": 93551
},
{
"state": "Active",
"language_code": "en",
"name": "central.gymshark.com",
"rank": 93942
},
{
"state": "Active",
"language_code": "en",
"name": "ie.gymshark.com",
"rank": 97206
},
{
"state": "Redirects",
"name": "de-en.gymshark.com",
"rank": 14999999
},
{
"state": "Redirects",
"name": "m.gymshark.com",
"rank": 14999999
},
{
"state": "Redirects",
"name": "www.uk.gymshark.com",
"rank": 14999999
},
{
"state": "Redirects",
"name": "gymshark.com",
"rank": 14999999
}
]
}
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:
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 often 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 allowing the TCP connection to close. Depending on the RAM available on your servers and the number of domains that you are retrieving, you may be able to read the entire response into memory. If that is not an option, consider writing the response to a temporary file on disk instead. Then, run whatever processing is necessary on the persisted results.
Historical Domain Data
The Store Leads database only includes information for stores that are currently live. If a store was created in early 2020 but no longer exists, then it is not included in the main Store Leads database. However, there are a variety of use cases that need historical data. We have been archiving our weekly updates since early 2019 and they are available for download to accounts on our Elite Plan.
List Historical Domain Labels
Returns a list of labels identifying the weekly historical domain data. The label is used to download a specific weekly archive.
Example Request
$ curl -H 'Authorization: Bearer your.api.key' 'https://storeleads.app/json/api/v1/all/historical/domain'
Example Response
{
"labels": [
"20190218092912",
"20190227134551",
"20190304082117",
"20190311085351",
"20190318082207",
"20190325191823",
"20190403101554",
"20190407214523",
"20190417115057",
"20190421224615",
"20190429090715",
"20190506114709",
"20190513073041",
"20190520073516",
"20190527093528",
"20190603075609",
"20190610074320",
"20190617070742",
"20190624111028",
"20190703124137",
"20190707191027",
"20190715092554",
"20190722093326",
"20190728160710",
"20190805082041",
"20190812075123",
"20190818203216",
"20190826111509",
"20190904111622",
"20190909084125",
"20190916091636",
"20190925122344",
"20190929203713",
"20191007112852",
"20191014091114",
"20191022075327",
"20191029075012",
"20191104100921",
"20191110193432",
"20191118082405",
"20191125180407",
"20191202122535",
"20191210083939",
"20191216090111",
"20191224064444",
"20200107081949",
"20200113084204",
"20200119192542",
"20200128190643",
"20200205134222",
"20200211142710",
"20200218125517",
"20200224092439",
"20200304075613",
"20200310160715",
"20200316181853",
"20200323070939",
"20200329190223",
"20200406085043",
"20200414070452",
"20200420194544",
"20200427074213",
"20200506154523",
"20200511134937",
"20200527084641",
"20200601063420",
"20200609101137",
"20200617134604",
"20200622064615",
"20200629203612",
"20200706102742",
"20200713074823",
"20200720065542",
"20200727071119",
"20200803084521",
"20200812130603",
"20200817072035",
"20200824132034",
"20200901091737",
"20200908072535",
"20200915074744",
"20200921072643",
"20200928075254",
"20201005090041",
"20201012105058",
"20201019093048",
"20201027075023",
"20201103195627",
"20201109094755",
"20201117103343",
"20201123135824",
"20201130070451",
"20201207082905",
"20201214133659",
"20201222075353",
"20201229111529",
"20210105201201",
"20210111145026",
"20210117202955",
"20210125193859",
"20210131195453",
"20210208080330",
"20210216083405",
"20210223150323",
"20210302072701",
"20210309065709",
"20210315202640",
"20210322214628",
"20210329184849",
"20210406205515",
"20210412150450",
"20210419064809",
"20210426074742",
"20210502180739",
"20210510062325",
"20210517060518",
"20210524142656",
"20210530214213",
"20210607023242",
"20210614142232",
"20210621182727",
"20210629013444",
"20210704233531",
"20210711181833",
"20210718200634",
"20210726134443",
"20210802063326",
"20210809023919",
"20210817181726",
"20210823061817",
"20210830073414",
"20210906171310",
"20210912194701",
"20210920074928",
"20210927025807",
"20211005160251",
"20211010181202",
"20211018064626",
"20211026015210",
"20211101042006",
"20211108145039",
"20211114155639",
"20211121234757",
"20211128182059",
"20211206152603",
"20211212185751",
"20211219201107",
"20211226220141",
"20220102231528",
"20220110041749",
"20220116154800",
"20220123181934",
"20220130222422",
"20220206223325",
"20220213191036",
"20220220194254",
"20220227211854",
"20220306235926",
"20220314002910",
"20220320162154",
"20220327194059",
"20220404005545",
"20220410214639",
"20220417145954",
"20220424164423",
"20220502005248",
"20220508172859",
"20220515233416",
"20220522162016",
"20220529155049",
"20220605220333",
"20220612173900",
"20220619204931",
"20220626174212",
"20220703181215",
"20220710180111",
"20220718160959",
"20220724165254",
"20220731193206",
"20220807210841",
"20220815002357",
"20220822060842",
"20220828202008",
"20220905035500",
"20220911200404",
"20220918222642"
]
}
List Domains from Historical Data
This endpoint retrieves all domains from a historical dataset. You must provide a label to identify the dataset. It is not possible to filter this endpoint, so all domains that existed at the given time will be included in the results and you'll need to filter the results after retrieving the data.
Data is returned in JSONL format (one document per line).
Use the fields request option to customize the fields included in the response.
Request Options
A comma-separated list of fields to include in the response. All default 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.
Return no more than the provided number of records.
Example Request
$ curl -H 'Authorization: Bearer your.api.key' 'https://storeleads.app/json/api/v1/all/historical/domain/20210208080330?fields=name,platform&limit=5'
Lists
Lists objects represent a collection of Domains. Learn more about Lists in our Lists documentation. The API allows you to retrieve information for a List based on its name or by showing all lists that exist. Your API key can access information for any List created by any Account in your organization.
The attributes of the List object are documented below.
Retrieve a List
Retrieves the details of a List. You must provide the name of the List to lookup.
Example Request
$ curl -H 'Authorization: Bearer your.api.key' 'https://storeleads.app/json/api/v1/all/list/List%20Name'
Example Response
{
"list": {
"id": 3,
"name": "List Name",
"author_email": "foo@example.com",
}
}
List Lists
Returns a list of Lists that your Account can access.
Example Request
$ curl -H 'Authorization: Bearer your.api.key' 'https://storeleads.app/json/api/v1/all/list'
Example Response
{
"lists": [
{
"id": 3,
"name": "List Name",
"author_email": "foo@example.com",
}
]
}
Add Domains to List
Adds a set of Domains to a List.
Example Request
$ curl -H 'Authorization: Bearer your.api.key' -X PUT -H "Content-Type: application/json" -d '{"domains": ["kyliecosmetics.com","www.fashionnova.com","unrecognized.com"]}' 'https://storeleads.app/json/api/v1/all/list/List%20Name/add-domains'
Example Response
{
"list": {
"id": 3,
"name": "List Name",
"author_email": "foo@example.com",
},
"count_domains_added": 2,
"unrecognized_domains": [
"unrecognized.com"
]
}
Remove Domains from List
Removes a set of Domains from a List.
Example Request
$ curl -H 'Authorization: Bearer your.api.key' -X PUT -H "Content-Type: application/json" -d '{"domains": ["kyliecosmetics.com","www.fashionnova.com","unrecognized.com"]}' 'https://storeleads.app/json/api/v1/all/list/List%20Name/remove-domains'
Example Response
{
"list": {
"id": 3,
"name": "List Name",
"author_email": "foo@example.com",
},
"count_domains_removed": 2,
"unrecognized_domains": [
"unrecognized.com"
]
}
Social Media Accounts
Social Media Account objects represent a handle on a social media network that is associated with a Domain in the Store Leads database.
The attributes of the Social Media Account object are documented below.
Retrieve a Social Media Account
Retrieves the details of a Social Media Account.
Example Request
$ curl -H 'Authorization: Bearer your.api.key' 'https://storeleads.app/json/api/v1/all/social?url=https://twitter.com/amazon'
Example Response
{
"details": {
"description": "Official Twitter account of Amazon. Contact @AmazonHelp for customer support. Follow @AmazonNews for the latest news from Amazon.",
"followers": 4605646,
"followers_90d": 228817,
"following": 52,
"posts": 44433,
"type": "twitter",
"value": "https://twitter.com/amazon"
},
"domain_names": [
"www.amazon.com",
"www.amazon.co.uk",
"www.amazon.ca",
"amazon-basics.club"
]
}
Technologies
Technology objects represent a technology that a store can install on their website. Technologies differ from Apps in that they are not installed through the ecommerce platform's App Store and therefore are cross-platform.
The attributes of the Technology object are documented below.
The time at which the Technology was installed by a Domain.
Retrieve a Technology
Retrieves the details of a Technology.
Example Request
$ curl -H 'Authorization: Bearer your.api.key' 'https://storeleads.app/json/api/v1/all/technology/Yoast'
Example Response
{
"technology": {
"name": "Yoast",
"description": "Yoast helps you with your website optimization, whether it be through our widely used SEO software or our online SEO courses: we're here to help.",
"icon_url": "https://storeleads.app/img/tech/yoast.png",
"installs": 1634438
}
}
List Technologies
Returns a list of Technologies. By default, 50 Technologies are returned in a single request. The page request option can be used to paginate.
Request Options
A comma-separated list of fields to include in the response. All default 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.
The page of results to return. Default: 0.
The number of Apps to return in a single query. Default: 50, Max: 50.
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:
- installs
Filters Technologies based on a text query.
Example Request
$ curl -H 'Authorization: Bearer your.api.key' 'https://storeleads.app/json/api/v1/all/technology?page_size=2&sort=-installs'
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,"sort":"-installs"}' 'https://storeleads.app/json/api/v1/all/technology'
Example Response
{
"technologies": [
{
"name": "Gorgias",
"description": "Gorgias provides flawless customer service for ecommerce stores",
"icon_url": "https://storeleads.app/img/tech/gorgias.png",
"installs": 11611
},
{
"name": "Segment",
"description": "Segment is a customer data platform that makes good data accessible for all teams.",
"icon_url": "https://storeleads.app/img/tech/segment.png",
"installs": 4872
}
]
}
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.
- If you don't already have it installed, visit https://www.getpostman.com/ and install the Postman client.
- Click the Run in Postman button below to open Postman and import the Store Leads API Postman collection.
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.