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.

Authentication

Authenticate your account by including your API key in requests. You can see your API key on your 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 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.
icon_url
The URL of the App's icon.
installed_at

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

This field is only returned if the request returns Domains and the field is included explicitly within the fields request parameter.

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.
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": {
    "token": "marsello",
    "name": "Marsello | Email \u0026 Loyalty",
    "categories": [
      "marketing"
    ],
    "app_store_url": "https://apps.shopify.com/marsello",
    "plans": [
      {
        "name": "Free",
        "monthly_cost": "Free"
      },
      {
        "name": "Pro",
        "monthly_cost": "$49/month",
        "monthly_cost_cents": 4900
      }
    ],
    "description": "Grow sales with loyalty \u0026 email automation + holiday campaigns",
    "installs": 5585,
    "platform": "shopify",
    "vendor_name": "Marsello",
    "vendor_url": "https://apps.shopify.com/partners/recovermycart",
    "vendor_email": "help@marsello.com",
    "review_count": 271,
    "average_rating": "4.8",
    "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:p

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

Valid values are:

  • shopify
  • bigcommerce
  • square

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.

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.

Valid values are:

  • created_at
  • -created_at

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": [
    {
      "token": "privy",
      "name": "Privy ‑ Exit Pop Ups \u0026 Email",
      "categories": [
        "store design",
        "marketing"
      ],
      "app_store_url": "https://apps.shopify.com/privy",
      "plans": [
        {
          "name": "Free",
          "monthly_cost": "Free to install"
        },
        {
          "name": "Growth",
          "monthly_cost": "$20/month",
          "monthly_cost_cents": 2000
        },
        {
          "name": "Privy Email",
          "monthly_cost": "$10/month",
          "monthly_cost_cents": 1000
        }
      ],
      "description": "Pop Ups w/exit intent, Email Marketing, Abandonment \u0026 Wheels",
      "installs": 69105,
      "platform": "shopify",
      "vendor_name": "Privy",
      "vendor_url": "https://apps.shopify.com/partners/privy",
      "vendor_email": "support@privy.com",
      "review_count": 22325,
      "average_rating": "4.7",
      "icon_url": "https://apps.shopifycdn.com/listing_images/f3d61c764a54b22aed51cd1cc31b5a74/icon/888f61efc26889908078d0cce0756361.png?height=84\u0026width=84",
      "state": "Active",
      "created_at": "2018-10-30T00:00:00"
    },
    {
      "token": "free-shipping-bar",
      "name": "Free Shipping Bar by Hextom",
      "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": 45898,
      "platform": "shopify",
      "vendor_name": "Hextom",
      "vendor_url": "https://apps.shopify.com/partners/hextom",
      "vendor_email": "help@hextom.com",
      "review_count": 8579,
      "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 domain names that refer to this Domain. Aliases are identified as other Domain names that point to the Domain through canonical links or redirects.
apps
List of Apps that the Domain has installed.
app_count_time_series

A time series of installed app counts for the Domain. Data goes back to 2018/12.

This field is only returned if it is included explicitly within the fields request parameter.

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")
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:

  • company: boolean value indicating whether the identifier is associated with a business
  • followers: number of followers (present only for twitter, instagram, facebook and pinterest handles)
  • redacted: boolean value indicating whether the identifier was redacted to comply with local privacy regulations
  • 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.
inactive_at
The date at which data the Domain became Inactive. Only set for Domains in Inactive state.
last_updated_at
The date at which data for the Domain was last updated.
monthly_app_spend
The estimated amount the merchant spends on apps every month. Values in cents of USD.
monthly_app_spend_time_series

A time series of monthly app spend for the Domain. Data goes back to 2019/08.

This field is only returned if it is included explicitly within the fields request parameter.

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.
platform_rank_time_series

A time series of platform rank changes for the Domain. Data goes back to 2019/09.

This field is only returned if it is included explicitly within the fields request parameter.

product_count

The number of products sold by the Domain.

Value is not returned if we are unable to determine the number of products sold. Maximum value is 250. If the value of this field is 250, it means that the Domain sells at least 250 products.

product_count_time_series

A time series of the number of products sold by the Domain. Data goes back to 2019/06.

This field is only returned if it is included explicitly within the fields request parameter.

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.
rank_time_series

A time series of rank changes for the Domain. Data goes back to 2019/06.

This field is only returned if it is included explicitly within the fields request parameter.

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
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.

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": 137041,
    "aliases": [
      "vapescom.myshopify.com"
    ],
    "apps": [
      {
        "token": "also-bought",
        "name": "Also Bought • Related Products",
        "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": "Amazon-like 'Customers Who Bought Also Bought' recommendations",
        "installs": 7175,
        "platform": "shopify",
        "vendor_name": "Code Black Belt",
        "vendor_url": "https://apps.shopify.com/partners/codeblackbelt",
        "vendor_email": "support@codeblackbelt.com",
        "review_count": 549,
        "average_rating": "5.0",
        "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"
      },
      {
        "token": "back-in-stock",
        "name": "Back In Stock: Customer Alerts",
        "categories": [
          "sales and conversion optimization"
        ],
        "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": "Large Store",
            "monthly_cost": "$59/month",
            "monthly_cost_cents": 5900
          }
        ],
        "description": "Notify your customers when products are restocked: Email \u0026 SMS",
        "installs": 7209,
        "platform": "shopify",
        "vendor_name": "SureSwift Capital",
        "vendor_url": "https://apps.shopify.com/partners/wdh",
        "vendor_email": "support@backinstock.org",
        "review_count": 209,
        "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"
      },
      {
        "token": "conversio",
        "name": "Campaign Monitor | Commerce",
        "categories": [
          "store design",
          "marketing",
          "sales and conversion optimization"
        ],
        "app_store_url": "https://apps.shopify.com/conversio",
        "plans": [
          {
            "name": "Starter",
            "monthly_cost": "$9/month",
            "monthly_cost_cents": 900
          },
          {
            "name": "Growth",
            "monthly_cost": "$29/month",
            "monthly_cost_cents": 2900
          },
          {
            "name": "Professional",
            "monthly_cost": "$49/month",
            "monthly_cost_cents": 4900
          }
        ],
        "description": "Email Marketing Automation and UGC. Previously Conversio.",
        "installs": 4772,
        "platform": "shopify",
        "vendor_name": "Conversio",
        "vendor_url": "https://apps.shopify.com/partners/receiptful",
        "vendor_email": "help@conversio.com",
        "review_count": 965,
        "average_rating": "4.8",
        "icon_url": "https://apps.shopifycdn.com/listing_images/05d3dad30666912ea0d52df60e35de42/icon/7e99d106d50318c2638d5cab3fcaa34d.png?height=84\u0026width=84",
        "removed_at": "2019-10-09T13:26:41.362688312Z",
        "state": "Inactive",
        "created_at": "2018-10-30T00:00:00"
      },
      {
        "token": "free-shipping-bar",
        "name": "Free Shipping Bar by Hextom",
        "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": 45898,
        "platform": "shopify",
        "vendor_name": "Hextom",
        "vendor_url": "https://apps.shopify.com/partners/hextom",
        "vendor_email": "help@hextom.com",
        "review_count": 8579,
        "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"
      },
      {
        "token": "generic-zotabox",
        "name": "Zotabox",
        "app_store_url": "https://apps.shopify.com/partners/zotabox",
        "description": "Boost Your Sales with 15 Free Marketing Tools",
        "installs": 28943,
        "platform": "shopify",
        "vendor_name": "Zotabox",
        "vendor_url": "https://info.zotabox.com/",
        "state": "Active",
        "created_at": "2018-11-01T00:00:00"
      },
      {
        "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": 150537,
        "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"
      },
      {
        "token": "marsello",
        "name": "Marsello | Email \u0026 Loyalty",
        "categories": [
          "marketing"
        ],
        "app_store_url": "https://apps.shopify.com/marsello",
        "plans": [
          {
            "name": "Free",
            "monthly_cost": "Free"
          },
          {
            "name": "Pro",
            "monthly_cost": "$49/month",
            "monthly_cost_cents": 4900
          }
        ],
        "description": "Grow sales with loyalty and email marketing automation",
        "installs": 5585,
        "platform": "shopify",
        "vendor_name": "Marsello",
        "vendor_url": "https://apps.shopify.com/partners/recovermycart",
        "vendor_email": "help@marsello.com",
        "review_count": 270,
        "average_rating": "4.8",
        "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"
      },
      {
        "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": 47554,
        "platform": "shopify",
        "vendor_name": "Printful",
        "vendor_url": "https://apps.shopify.com/partners/jansons",
        "vendor_email": "support@printful.com",
        "review_count": 2565,
        "average_rating": "4.6",
        "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"
      },
      {
        "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 items with your design, we manage fulfillment",
        "installs": 12941,
        "platform": "shopify",
        "vendor_name": "Printify",
        "vendor_url": "https://apps.shopify.com/partners/printifyapp",
        "vendor_email": "merchantsupport@printify.com",
        "review_count": 1278,
        "average_rating": "4.6",
        "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"
      },
      {
        "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": 161399,
        "platform": "shopify",
        "vendor_name": "Shopify",
        "vendor_url": "https://apps.shopify.com/partners/shopify",
        "vendor_email": "support@shopify.com",
        "review_count": 1219,
        "average_rating": "4.5",
        "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"
      },
      {
        "token": "product-reviews-addon",
        "name": "Stamped.io Reviews \u0026 UGCs",
        "categories": [
          "store design",
          "sales and conversion optimization"
        ],
        "app_store_url": "https://apps.shopify.com/product-reviews-addon",
        "plans": [
          {
            "name": "Lite",
            "monthly_cost": "Free"
          },
          {
            "name": "Starter",
            "monthly_cost": "$9/month",
            "monthly_cost_cents": 900
          },
          {
            "name": "Premium",
            "monthly_cost": "$29/month",
            "monthly_cost_cents": 2900
          },
          {
            "name": "Business",
            "monthly_cost": "$69/month",
            "monthly_cost_cents": 6900
          }
        ],
        "description": "Collect product reviews, site reviews, photos/video and Q\u0026A",
        "installs": 21555,
        "platform": "shopify",
        "vendor_name": "Stamped.io",
        "vendor_url": "https://apps.shopify.com/partners/shopry",
        "vendor_email": "hello@stamped.io",
        "review_count": 2386,
        "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"
      },
      {
        "token": "web-push-notification",
        "name": "Smart Push Marketing ‑ WebPush",
        "categories": [
          "store design",
          "sales and conversion optimization"
        ],
        "app_store_url": "https://apps.shopify.com/web-push-notification",
        "plans": [
          {
            "name": "Free",
            "monthly_cost": "Free"
          }
        ],
        "description": "Abandoned carts recovery via web push notifications",
        "installs": 6162,
        "platform": "shopify",
        "vendor_name": "Hextom",
        "vendor_url": "https://apps.shopify.com/partners/hextom",
        "vendor_email": "help@hextom.com",
        "review_count": 1059,
        "average_rating": "4.8",
        "icon_url": "https://apps.shopifycdn.com/listing_images/fec74ce17a5efaa984226d7f9273f259/icon/26b3d96ac232704952ef3a85354c0351.jpg?height=84\u0026quality=90\u0026width=84",
        "state": "Active",
        "created_at": "2018-10-30T00:00:00"
      }
    ],
    "avg_price": 2613,
    "monthly_app_spend": 2999,
    "categories": [
      "/Smoking \u0026 Vaping"
    ],
    "country_code": "US",
    "currency_code": "USD",
    "contact_info": [
      {
        "company": true,
        "followers": 4058,
        "source": "/",
        "type": "twitter",
        "value": "https://twitter.com/vapescom"
      },
      {
        "company": true,
        "followers": 36625,
        "source": "/",
        "type": "facebook",
        "value": "https://facebook.com/vapescom"
      },
      {
        "company": true,
        "followers": 17397,
        "source": "/",
        "type": "instagram",
        "value": "https://instagram.com/vapescom"
      },
      {
        "company": true,
        "source": "/",
        "type": "email",
        "value": "help@vapes.com"
      },
      {
        "company": true,
        "source": "/",
        "type": "phone",
        "value": "612-200-1962"
      },
      {
        "company": true,
        "source": "/",
        "type": "phone",
        "value": "612-254-2649"
      },
      {
        "company": true,
        "followers": 1213,
        "source": "/pages/newsletter",
        "type": "pinterest",
        "value": "https://www.pinterest.com/vapescom"
      }
    ],
    "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.",
    "name": "www.vapes.com",
    "plan": "Shopify Plus",
    "platform_rank": 769,
    "product_count": 250,
    "platform": "shopify",
    "rank": 1547,
    "state": "Active",
    "technologies": [
      {
        "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."
      }
    ],
    "theme": {
      "name": "empire",
      "style": "Graphic",
      "vendor": "Pixel Union",
      "version": "Unknown",
      "cost": 18000
    },
    "title": "VAPES E-Cigs, E-juice, Wax Vape Pens, Herbal Vaporizers",
    "created_at": "2016-12-30T00:00:00",
    "last_updated_at": "2019-10-01T00: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 page request option can be used to paginate through the first few pages or can be set to -1 to retrieve all Domains. See the page option below for more details.

Request Options
aq

Filters the results to Domains matching the Advanced Search.

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: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: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: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: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: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: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: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: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:

  • shopify
  • bigcommerce
  • square

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: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: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: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.

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

The page of results to return. Default: 0, Maximum: 10.

Use page=-1 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 page=-1, results are generated asynchronously and the 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 }

page_size

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

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": 109812,
      "categories": [
        "/Apparel/Eyewear",
        "/Health/Vision Care/Eyeglasses \u0026 Contacts"
      ],
      "country_code": "US",
      "contact_info": [
        {
          "company": true,
          "followers": 213,
          "source": "/",
          "type": "twitter",
          "value": "https://twitter.com/ZeeloolOptical"
        },
        {
          "company": true,
          "followers": 215882,
          "source": "/",
          "type": "facebook",
          "value": "https://www.facebook.com/zeelooloptical"
        },
        {
          "company": true,
          "followers": 111205,
          "source": "/",
          "type": "instagram",
          "value": "https://www.instagram.com/zeelool"
        },
        {
          "company": false,
          "source": "/",
          "type": "email",
          "value": "complaint@zeelool.com"
        },
        {
          "company": true,
          "source": "/",
          "type": "email",
          "value": "support@zeelool.com"
        },
        {
          "company": true,
          "source": "/",
          "type": "email",
          "value": "wholesale@zeelool.com"
        },
        {
          "company": true,
          "followers": 2105,
          "source": "/",
          "type": "pinterest",
          "value": "https://www.pinterest.com/zeelool"
        },
        {
          "company": true,
          "source": "/",
          "type": "phone",
          "value": "+1 (302) 990-0619"
        },
        {
          "company": true,
          "followers": 216,
          "source": "/",
          "type": "youtube",
          "value": "https://www.youtube.com/channel/UCCalvnmkN_2Lmpt1TKjD7CA"
        },
        {
          "company": true,
          "source": "/ordertrack",
          "type": "phone",
          "value": "+1-(888)-721-8019"
        },
        {
          "company": true,
          "source": "/ordertrack",
          "type": "phone",
          "value": "+852 63548272"
        },
        {
          "company": true,
          "source": "/cateye.html",
          "type": "email",
          "value": "admin@zeelool.com"
        },
        {
          "company": true,
          "source": "/contact_us",
          "type": "email",
          "value": "market@zeelool.com"
        }
      ],
      "merchant_name": "www.zeelool.com",
      "description": "We offer cheap thick prescription glasses online featuring lightweight, vintage wide horn rimmed cat eye eyeglasses including acetate, wooden material eyeglasses, retro sunglasses and 1.75 reading glasses.",
      "name": "www.zeelool.com",
      "platform_rank": 247,
      "platform": "magento",
      "rank": 509,
      "state": "Active",
      "technologies": [
        {
          "name": "Bing Ads",
          "description": "Bing Ads conversion tracking collects data that allows you to track conversion goals and target audiences with remarketing lists."
        },
        {
          "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."
        },
        {
          "name": "Facebook Pixel",
          "description": "A 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."
        },
        {
          "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."
        }
      ],
      "theme": {
        "name": "Unknown",
        "style": "Unknown",
        "vendor": "Unknown",
        "version": "Unknown"
      },
      "title": "Zeelool |Stylish Prescription Glasses, Affordable Eyeglasses online",
      "created_at": "2018-11-16T00:00:00",
      "last_updated_at": "2019-10-04T00:00:00"
    },
    {
      "alexa_rank": 107599,
      "categories": [
        "/Beauty \u0026 Fitness/Fitness"
      ],
      "country_code": "US",
      "contact_info": [
        {
          "company": true,
          "followers": 4483,
          "source": "/",
          "type": "twitter",
          "value": "https://twitter.com/lifespanfitness"
        },
        {
          "company": true,
          "followers": 4404,
          "source": "/",
          "type": "facebook",
          "value": "https://www.facebook.com/lifespan"
        },
        {
          "company": true,
          "followers": 882,
          "source": "/",
          "type": "instagram",
          "value": "https://www.instagram.com/lifespan_fitness"
        },
        {
          "company": false,
          "source": "/",
          "type": "email",
          "value": "yourorder@lifespanfitness.com"
        },
        {
          "company": true,
          "followers": 1610,
          "source": "/",
          "type": "pinterest",
          "value": "https://pinterest.com/lifespanfitness"
        },
        {
          "company": true,
          "source": "/",
          "type": "phone",
          "value": "877.654.3837"
        },
        {
          "company": true,
          "source": "/",
          "type": "linkedin",
          "value": "https://www.linkedin.com/company/lifespanfitness"
        },
        {
          "company": true,
          "source": "/tr800-dt5-treadmill-desk",
          "type": "phone",
          "value": "801.972.5705"
        }
      ],
      "merchant_name": "www.lifespanfitness.com",
      "description": "Purchase award-winning exercise equipment including treadmills, treadmill desks, bikes, rowers and more. Free Shipping and No Interest Financing.",
      "name": "www.lifespanfitness.com",
      "platform_rank": 330,
      "platform": "magento",
      "rank": 670,
      "state": "Active",
      "technologies": [
        {
          "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."
        }
      ],
      "theme": {
        "name": "Unknown",
        "style": "Unknown",
        "vendor": "Unknown",
        "version": "Unknown"
      },
      "title": "LifeSpan Fitness | Home, Gym \u0026 Workplace Exercise Equipment",
      "created_at": "2018-11-23T00:00:00",
      "last_updated_at": "2019-10-04T00:00:00"
    }
  ],
  "total": 21796
}

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:

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
curr
Currency Code
cratyyyymm
Created At YYYY-MM
cratyyyymmdd
Created At YYYY-MM-DD
ds
Domain State
ismy
Domain Type
it
Contact Information
mas
Monthly App Spend
p
Platform
q
Query
rank
Rank
reg
Region
sreg
Subregion
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 page request option of the List Domains endpoint (by passing page=-1) 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.

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.