API Reference

Introduction

The reference is your key to a comprehensive understanding of the Bootleads API.

Conventions

The base URL to send all API requests is https://bootleads.com/api/v1/. HTTPS is required for all API requests. The Bootleads API follows RESTful conventions where possible, and both request and response bodies are encoded in JSON format.

Authentication

To obtain API access, you’ll need to subscribe to Boatloads Enterprise. Once subscribed, you can find your API key on your account page.

All API requests require authentication by including your API key in the HTTP Authorization header.

Authorization: Bearer YOUR_API_KEY

Pagination

Endpoints that return lists of objects support cursor-based pagination requests. By default, Bootleads returns 50 items per API call. If the number of items in a response from a support endpoint exceeds the default, then an integration can use pagination to request a specific set of the results and/or to limit the number of returned items.

Page Response Fields

Field Type Description
has_more boolean

Whether the response includes the end of the list.false if there are no more results.

Otherwise,true.

next_cursor string

A string that can be used to retrieve the next page of results by passing the value as the start_cursor parameter to the same endpoint.Only available when has_more is true.

The cursor for the next page is valid for 1 minute,you need to request the next page within 1 minute.
next_page_url string

The URL for retrieving the next page of results, if more results are available. If this field is empty string, there are no additional pages.

Parameters for paginated requests

Parameter Type Description
page_size number

The number of items from the full list to include in the response.

Default: 50

Maximum: 100

The response may contain fewer than the default number of results.

start_cursor string

A next_cursor value returned in a previous response. Treat this as an opaque value.

Defaults to undefined, which returns results from the beginning of the list.

RateLimits

Each API endpoint has a rate limit. If an account sends more than the allowed number of requests in a given time period, the API will respond with an HTTP 429 error code. The response will include a Retry-After header that contains the number of seconds to wait before trying again.

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

Objects

Domain

Each domain object includes the following fields:

Field Type Description
domain string

The DNS domain name of the Domain.

platform string (enum)

The name of the ecommerce platform that powers the Domain.

platform_domain string

eg. abcdd.myshopify.com

domain_reg_date string

The date the domain was registered.(if known)

title string

Title of the store

meta_desc string

Meta description for SEO purposes

language_code string (enum)

The 2-letter ISO 639-1 code for the language of content on the Domain's website. Value is blank is not known.

country_code string (enum)

The 2-letter ISO country code of the Domain.

currency_code string (enum)

The 3-letter ISO currency code of the Domain.

product_count number

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.

product_avg_price number

The average price of products sold on the Domain.

latest_product_upload_date string

Date of the most recent product upload.

latest_product_title string

Title of the most recently uploaded product.

latest_product_url string

URL of the most recent product.

product_type array

Type or category of products sold by the store.

vendor array

Partial vendor list. Available only for Shopify stores.

tags array

Store-related tags (e.g., [dropshipping, pod, ]).

technologies array

Technologies integrated into the store, such as tracking or analytics tools

fb_ad_count number

The number of advertisements placed on Facebook for this domain in the past 30 days. The data is an estimated value. A null value indicates unknown.

fb_page_ids array

List of Facebook page IDs running ads.

apps array

List of Apps that the Domain has installed.Currently only available for Shopify stores.

contact_page string

The URL of the Domain's "Contact Us" (if any).

about_page string

The URL of the Domain's "About Us" (if any).

faq_page string

The URL of the Domain's "FAQS" (if any).

return_page string

The URL of the Domain's "Returns/Exchanges Page" (if any).

email string

Contact email address associated with the store.

whatsapp string

WhatsApp contact number linked to the store.

telephone string

Store’s contact telephone number.

ships_to_countries array

A list of countries to which the store ships. Only available for Shopify stores.

social_media_accounts array

List of social media account handles associated with the store.

plan string

The name of the ecommerce platform's pricing plan that the merchant is using (if known). e.g., "Shopify Plus"

redirect_to string

This domain will redirect to [redirect_to]

password_protected bool

This store requires a password to access.

indexed_at string

Date when the system indexed this domain.

updated_at string

The date at which data for the Domain was last updated.

Endpoints

List All Domains

Retrieves a list of Domains. Supports filtering results through optional request parameters. Returns the complete list of Domains when no parameters are specified.

URL
https://bootleads.com/api/v1/domains
Method
GET
Rate Limit
3 requests/second

Request Params

keyword
e.g. keyword=pet

matching the word "pet" in one of the following fields:

  • title
  • meta_desc
  • vendor
  • domain (prefix match only)
  • latest_product_title
  • product_type

Field description reference domain object

domain
e.g. domain=example.com

Returns all data associated with the specified domain, including its subdomains (e.g., us.example.com, cn.example.com)

indexed_at
Filter results based on system indexing date.

Accepted date formats:

  • "yesterday": Previous UTC date (00:00:00 UTC to 23:59:59 UTC), e.g. indexed_at=yesterday
  • Specific date: "YYYY-MM-DD", e.g. indexed_at=2024-11-11
  • Date range: "YYYY-MM-DD:YYYY-MM-DD", e.g. indexed_at=2024-11-11:2024-12-11

Time handling: All dates are interpreted in UTC timezone

Limitations: Historical data starts from 2024-01-01 UTC

💡 Tips for data synchronization:

To maintain data consistency, we recommend setting up a daily cron job that runs with indexed_at=yesterday. This ensures you capture complete daily data since each UTC day's data is finalized after the day ends.

platform
e.g. platform=shopify,woocommerce
Filters results by platform. Valid values are "shopify", "bigcommerce", "woocommerce", "wix", and "magento". To filter by multiple platforms, separate values with commas.
language_code
e.g. language_code=en,es,pt
country_code
e.g. country_code=US,GB
currency_code
e.g. currency_code=USD,EUR
product_count_min
e.g. product_count_min=10

Filter results with product_count greater than or equal to 10.

product_count_max
e.g. product_count_max=100

Filter results with product_count less than or equal to 100.

product_avg_price_min
e.g. product_avg_price_min=10

Filter results with product_avg_price greater than or equal to 10.

product_avg_price_max
e.g. product_avg_price_max=100

Filter results with product_avg_price less than or equal to 100.

fb_ad_count_min
e.g. fb_ad_count_min=10

Filter results with fb_ad_count greater than or equal to 10.

fb_ad_count_max
e.g. fb_ad_count_max=100

Filter results with fb_ad_count less than or equal to 100.

Example Request

  
  curl -X GET 'https://bootleads.com/api/v1/domains?page_size=20' -H 'Authorization: Bearer your-api-key'
  

Responses

  
    {
      "has_more": true,
      "next_cursor": "eyJzIjpbMTczMDc5MjA2MzAwMCwxNzMwNzkyNjUyNjQzLDcwMTk2MTBdLCJwIjoidU15TUJBRU1jM1J2Y21WZlpHOXRZV2x1RmpOT1dGaFBVMlJKVTNseFpVdERTMGx2TmxsV2IzY0FGbWRzYUc5bmF6RTVVVXA1YkRaME9YVlFkMlpQTVdjQUFBQUFBQks1dHpZV01tcExhbXRFTlMxUmRrZElWVmRKVDNVeGVHMW5ad0FCRmpOT1dGaFBVMlJKVTNseFpVdERTMGx2TmxsV2IzY0FBQT09In0=",
      "next_page_url": "https://bootleads.com/api/v1/domains?page_size=20&start_cursor=eyJzIjpbMTczMDc5MjA2MzAwMCwxNzMwNzkyNjUyNjQzLDcwMTk2MTBdLCJwIjoidU15TUJBRU1jM1J2Y21WZlpHOXRZV2x1RmpOT1dGaFBVMlJKVTNseFpVdERTMGx2TmxsV2IzY0FGbWRzYUc5bmF6RTVVVXA1YkRaME9YVlFkMlpQTVdjQUFBQUFBQks1dHpZV01tcExhbXRFTlMxUmRrZElWVmRKVDNVeGVHMW5ad0FCRmpOT1dGaFBVMlJKVTNseFpVdERTMGx2TmxsV2IzY0FBQT09In0%3D",
      "results": [domain_object, domain_object]
    }
  

Example Response

  
   {
  "has_more": true,
  "next_cursor": "eyJzIjpbMTcxMzM3ODkzNTAwMCwxNzMwNTAwNDk1MjI2LDU1NDQwNTZdLCJwIjoidU15TUJBRU1jM1J2Y21WZlpHOXRZV2x1RmpOT1dGaFBVMlJKVTNseFpVdERTMGx2TmxsV2IzY0FGbWRzYUc5bmF6RTVVVXA1YkRaME9YVlFkMlpQTVdjQUFBQUFBQks1eThNV01tcExhbXRFTlMxUmRrZElWVmRKVDNVeGVHMW5ad0FCRmpOT1dGaFBVMlJKVTNseFpVdERTMGx2TmxsV2IzY0FBQT09In0=",
  "next_page_url": "https://bootleads.com/api/v1/domains?page_size=20&start_cursor=eyJzIjpbMTcxMzM3ODkzNTAwMCwxNzMwNTAwNDk1MjI2LDU1NDQwNTZdLCJwIjoidU15TUJBRU1jM1J2Y21WZlpHOXRZV2x1RmpOT1dGaFBVMlJKVTNseFpVdERTMGx2TmxsV2IzY0FGbWRzYUc5bmF6RTVVVXA1YkRaME9YVlFkMlpQTVdjQUFBQUFBQks1eThNV01tcExhbXRFTlMxUmRrZElWVmRKVDNVeGVHMW5ad0FCRmpOT1dGaFBVMlJKVTNseFpVdERTMGx2TmxsV2IzY0FBQT09In0%3D",
  "results": [
    {
      "domain": "colourpop.com",
      "platform": "shopify",
      "platform_domain": "colourpop-prd.myshopify.com",
      "domain_reg_date": "2012-07-07",
      "title": "ColourPop Cosmetics",
      "meta_desc": "Redefining luxury beauty by creating high quality products at affordable prices. We pride ourselves on being cruelty-free, wallet-friendly, and keeping our customers at the center of our world. Made in the USA, we imagine, innovate, test, and manufacture all under one roof.",
      "language_code": "en",
      "currency_code": "USD",
      "country_code": "US",
      "product_count": 1489,
      "fb_ad_count": 80,
      "fb_page_ids": [
        398774756661913,
        774841369193085
      ],
      "product_avg_price": 22.86,
      "latest_product_upload_date": "2024-04-17",
      "latest_product_title": "New Trainer",
      "latest_product_url": "https://colourpop.com/products/new-trainer-super-shock-shadow",
      "product_type": [
        "Face & Eye Gloss",
        "Lip and Cheek Balm",
        "Super Shock Shadow",
        "Shadow Palette & pH Lipstick Set",
        "Face Milk Mini Kit",
        "Ultra Lip Set",
        "......"
      ],
      "vendor": [
        "Fourth Ray Beauty",
        "ColourPop",
        "SOL Body"
      ],
      "tags": [
        "Shopify Plus"
      ],
      "technologies": [
        "Google Analytics",
        "Google Ads"
      ],
      "apps": [
        {
          "name": "Refersion: Affiliate Marketing",
          "image": "https://cdn.shopify.com/app-store/listing_images/b021799cb411d24623b60612a6228f1b/icon/CLGupLutiYADEAE=_100x.png",
          "slug": "refersion",
          "url": "https://apps.shopify.com/refersion"
        },
        {
          "name": "Geolocation",
          "image": "https://cdn.shopify.com/app-store/listing_images/eab6d2b98a02140e9655960f787ceb07/icon/CPKTxIqoh4ADEAE=_100x.png",
          "slug": "geolocation",
          "url": "https://apps.shopify.com/geolocation"
        },
        {
          "name": "Klevu ‑ AI Search & Discovery",
          "image": "https://cdn.shopify.com/app-store/listing_images/21a9df5710f533bed5c0bd66f913f8f4/icon/CIuDr7Hur_ACEAE=.jpeg",
          "slug": "klevu-smart-search",
          "url": "https://apps.shopify.com/klevu-smart-search"
        },
        {
          "name": "Signifyd",
          "image": "https://cdn.shopify.com/app-store/listing_images/adb1d4e7a8537b18730ab69339a13ad4/icon/CLX1-6b0lu8CEAE=_100x.png",
          "slug": "signifyd",
          "url": "https://apps.shopify.com/signifyd"
        }
      ],
      "contact_page": "",
      "about_page": "https://colourpop.com/pages/about-us",
      "faq_page": "https://colourpop.com/pages/klarna-faq",
      "return_page": "",
      "email": "",
      "whatsapp": "",
      "telephone": "",
      "ships_to_countries": [
        "AD",
        "AE",
        "....."
      ],
      "social_media_accounts": [
        {
          "url": "https://www.facebook.com/ColourPopCosmetics",
          "followers": 2300000
        },
        {
          "url": "https://www.instagram.com/colourpopcosmetics",
          "followers": 9938100
        },
        {
          "url": "https://twitter.com/ColourPopCo",
          "followers": 1329919
        }
      ],
      "plan": "Shopify Plus",
      "redirect_to": "",
      "password_protected": false,
      "indexed_at": "2023-05-25",
      "updated_at": "2024-11-01"
    },
      ....
  ]
}
  

Retrieve a Domain

Retrieves the details of a Domain.

URL
https://bootleads.com/api/v1/domains/[domain]
Method
GET
Rate Limit
5 requests/second

Example Request

  
  curl -X GET 'https://bootleads.com/api/v1/domains/kith.com' -H 'Authorization: Bearer your-api-key'
  

Example Response

  
      {
  "domain": "kith.com",
  "platform": "shopify",
  "platform_domain": "kithnyc.myshopify.com",
  "domain_reg_date": "2000-09-26",
  "title": "Kith",
  "meta_desc": "Apparel, Footwear, Sneakers, Boots, Shoes, Bags, Accessories, Lifestyle, Men's, Women's, Kid's, Ronnie Fieg, Men's Shoes & Footwear, Men's Accessories, Women's Shoes & Footwear, Women's Clothing, Women's Accessories, Kid's Shoes & Footwear, Kid's Accessories, Kid's Clothing | Kith | Kith Women | Kith Kids | Kith Treats",
  "language_code": "en",
  "currency_code": "USD",
  "country_code": "US",
  "product_count": 26560,
  "fb_ad_count": null,
  "fb_page_ids": [],
  "product_avg_price": 123.46,
  "latest_product_upload_date": "2024-10-25",
  "latest_product_title": "Jordan GS Air Jordan 14 - White / Black / Varsity Red / Metallic Silver",
  "latest_product_url": "https://kith.com/products/jb487524-160",
  "product_type": [
    "Pants",
    "Coveralls",
    "Tops",
    "Socks",
    "Crewnecks",
    "Bags",
    "...."
  ],
  "vendor": [
    "Kith",
    "Kith Kids",
    "Kith Baby",
    "Kith Women",
    "Jordan"
  ],
  "tags": [
    "Offers Installments",
    "Shopify Plus"
  ],
  "technologies": [
    "Google Analytics",
    "Google search console"
  ],
  "apps": [
    {
      "name": "Gorgias",
      "image": "https://cdn.shopify.com/app-store/listing_images/d783d0d0ded4ab7a13c20f47533819a3/icon/CNOe1Y-4vocDEAE=_100x.png",
      "slug": "helpdesk",
      "url": "https://apps.shopify.com/helpdesk"
    },
    {
      "name": "Kiwi Size Chart & Recommender",
      "image": "https://cdn.shopify.com/app-store/listing_images/d3885e152c3d7c1a0526f5f916b5d61e/icon/CJDcxMP0lu8CEAE=_100x.png",
      "slug": "kiwi-sizing",
      "url": "https://apps.shopify.com/kiwi-sizing"
    }
  ],
  "contact_page": "https://kith.com/pages/contact-us",
  "about_page": "https://kith.com/pages/about",
  "faq_page": "https://kith.com/pages/kith-for-invisible-friends-faqs",
  "return_page": "https://kith.com/pages/returns-and-exchanges",
  "email": "",
  "whatsapp": "",
  "telephone": "040017-001",
  "ships_to_countries": [
    "AD",
    "AE",
    "AG",
    "AI",
    "AL",
    "AM",
    "...."
  ],
  "social_media_accounts": [
    {
      "url": "https://www.facebook.com/Kithnyc",
      "followers": 147000
    },
    {
      "url": "https://www.instagram.com/kith",
      "followers": 3125029
    },
    {
      "url": "https://twitter.com/kith",
      "followers": 295454
    },
    {
      "url": "https://www.tiktok.com/@kith",
      "followers": null
    }
  ],
  "plan": "Shopify Plus",
  "redirect_to": "",
  "password_protected": false,
  "indexed_at": "2023-05-27",
  "updated_at": "2024-11-03"
}
  

Batch Retrieve Domains

Batch retrieve domain details. Maximum 50 domains per request. The response may contain fewer results than requested if some domains are not found.

URL
https://bootleads.com/api/v1/domains/batch
Method
POST
Rate Limit
5 requests/second

Example Request

  
      curl -X POST 'https://bootleads.com/api/v1/domains/batch' -H 'Authorization: Bearer your-api-key' -H 'Content-Type: application/json' -d '{"domains":["kith.com", "aa.com"]}'
  

Example Response

  
      {
  "results": [
    {
      "domain": "kith.com",
      "platform": "shopify",
      "platform_domain": "kithnyc.myshopify.com",
      "domain_reg_date": "2000-09-26",
      "title": "Kith",
      "meta_desc": "Apparel, Footwear, Sneakers, Boots, Shoes, Bags, Accessories, Lifestyle, Men's, Women's, Kid's, Ronnie Fieg, Men's Shoes & Footwear, Men's Accessories, Women's Shoes & Footwear, Women's Clothing, Women's Accessories, Kid's Shoes & Footwear, Kid's Accessories, Kid's Clothing | Kith | Kith Women | Kith Kids | Kith Treats",
      "language_code": "en",
      "currency_code": "USD",
      "country_code": "US",
      "product_count": 26560,
      "fb_ad_count": null,
      "fb_page_ids": [],
      "product_avg_price": 123.46,
      "latest_product_upload_date": "2024-10-25",
      "latest_product_title": "Jordan GS Air Jordan 14 - White / Black / Varsity Red / Metallic Silver",
      "latest_product_url": "https://kith.com/products/jb487524-160",
      "product_type": [
        "Pants",
        "Coveralls",
        "Tops",
        "Socks",
        "Crewnecks",
        "......"
      ],
      "vendor": [
        "Kith",
        "Kith Kids",
        "Kith Baby",
        "Kith Women",
        "Jordan"
      ],
      "tags": [
        "Offers Installments",
        "Shopify Plus"
      ],
      "technologies": [
        "Google Analytics",
        "Google search console"
      ],
      "apps": [
        {
          "name": "Gorgias",
          "image": "https://cdn.shopify.com/app-store/listing_images/d783d0d0ded4ab7a13c20f47533819a3/icon/CNOe1Y-4vocDEAE=_100x.png",
          "slug": "helpdesk",
          "url": "https://apps.shopify.com/helpdesk"
        },
        {
          "name": "Kiwi Size Chart & Recommender",
          "image": "https://cdn.shopify.com/app-store/listing_images/d3885e152c3d7c1a0526f5f916b5d61e/icon/CJDcxMP0lu8CEAE=_100x.png",
          "slug": "kiwi-sizing",
          "url": "https://apps.shopify.com/kiwi-sizing"
        }
      ],
      "contact_page": "https://kith.com/pages/contact-us",
      "about_page": "https://kith.com/pages/about",
      "faq_page": "https://kith.com/pages/kith-for-invisible-friends-faqs",
      "return_page": "https://kith.com/pages/returns-and-exchanges",
      "email": "",
      "whatsapp": "",
      "telephone": "040017-001",
      "ships_to_countries": [
        "AD",
        "AE",
        "AG",
        "....."
      ],
      "social_media_accounts": [
        {
          "url": "https://www.facebook.com/Kithnyc",
          "followers": 147000
        },
        {
          "url": "https://www.instagram.com/kith",
          "followers": 3125029
        },
        {
          "url": "https://twitter.com/kith",
          "followers": 295454
        },
        {
          "url": "https://www.tiktok.com/@kith",
          "followers": null
        }
      ],
      "plan": "Shopify Plus",
      "redirect_to": "",
      "password_protected": false,
      "indexed_at": "2023-05-27",
      "updated_at": "2024-11-03"
    }
  ]
}
  

Terms of Use

All APIs are governed by our standard terms.

You may integrate our data into your products, but may not:

  • - Resell raw data
  • - Replicate bootleads.com services