Export sites
export_sitesA bulk export of matching sites, up to 5,000 at once, for building a list or loading into a spreadsheet. Same filters as find_sites. Ask for csv output if the result is going into a file. For counts, shares or 'which X do these sites use', call stack_breakdown instead; it answers in one call and needs no export. Counts one site from the monthly allowance for each site not already returned to you this period, so this is the call most likely to ask you to confirm first.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| csv | No | Also return the rows as CSV text, ready to save as a file. | |
| near | No | Only sites near a place: a town or city, a postcode, or 'lat,lng', e.g. Bristol. Use with radius. Sites we could not place are left out. | |
| limit | No | How many sites to export, 1-5000. Default 1000. | |
| since | No | Earliest launch date, YYYY-MM-DD. | |
| until | No | Latest launch date, YYYY-MM-DD. Inclusive of the whole day. | |
| radius | No | How far from near, e.g. 30mi or 50km (a bare number is km). From 5 to 248 miles (8 to 400 km). | |
| confirm | No | Set true to skip the cost confirmation and return the data immediately. | |
| country | No | Country as an ISO 3166-1 alpha-2 code, e.g. GB. Names are accepted too. | |
| regions | No | Only sites in these states, provinces or other regions, e.g. ["Texas", "Oklahoma"]. Each a name, a name and country such as 'Georgia, US', or an id such as US-TX. A site matches if it is in ANY of them. Sites we could not place are left out. | |
| category | No | Product category, e.g. ecommerce. | |
| keywords | No | Whole words to look for in a site's name, title or description, e.g. photogrammetry. Matches ANY of them; a multi-word entry is a phrase. Three characters or more, up to ten words. Combines with every other filter, so 'Stripe sites that mention photogrammetry' is technology plus keywords. The same rule create_watch uses, so a word that filters here is the word a watch would fire on. | |
| technology | No | Technology name, exactly as returned by list_technologies. | |
| observedSince | No | Earliest date we first recorded the site, YYYY-MM-DD. Use this rather than 'since' when building an incremental export on a schedule. | |
| hasContactPage | No | Only sites that have a published contact page. Needs the 'contacts' permission. | |
| includeQuality | No | Include quality bands for each site. | |
| hasContactEmail | No | Only sites that have a published contact email. Needs the 'contacts' permission. |