API v2 Data Access

See what each package unlocks, how upgrade gates work, and which flat fields are returned by API v2.

Fields by package

This is the access model. Each API v2 field has one minimum package. Omit include to receive all fields available on the authenticated package, or request individual fields by name.

Example: include=domain,country,vat_number
Field Available from Type Label
domain Free string Domain
url Free string URL
country Free string Country
country_iso Free string Country ISO code
state Free string State / Region
state_iso Free string State / Region ISO code
city Free string City
text_lang Free string Language
is_ecommerce Free boolean E-commerce
ecommerce_probability Free number AI e-commerce probability
primary_platform Free string Primary platform
platforms Free array Platforms
category Free string Category
categories Free array Categories
subcategory Free string Subcategory
subcategories Free array Subcategories
subcategory_id Free string Subcategory ID
subcategory_ids Free array Subcategory IDs
meta_title Standard string Meta title
meta_description Standard string Meta description
tech Standard array Detected technology stack
tech_version Standard array Detected technology versions
premium_tech Standard array Detected premium technologies
tech_maturity_level Standard string Tech maturity level
estimated_monthly_tech_spend Standard number Estimated monthly tech spend
payment_providers Standard array Detected payment providers
shipping_carriers Standard array Detected shipping carriers
emails Standard array Emails
phones Standard array Phones
website_year Standard number Website year
website_month Standard string Website launch month
commoncrawl_web_presence_bucket Standard string Web Presence
commoncrawl_web_presence_trend_12m Standard string Web Presence Trend
company_name Premium string Company name
vat_number Premium string VAT number
vat_country Premium string VAT country
social Standard object Social links
store_age_tier Premium string Store age tier
first_seen_year Premium number First seen year
cross_border_countries Premium array Cross-border countries
cross_border_domains Premium array Cross-border domains
merchant_size_score Enterprise number Merchant size score
merchant_size_band Enterprise string Merchant size band
merchant_size_country_score Enterprise number Merchant size country score
merchant_size_country_band Enterprise string Merchant size country band
merchant_size_confidence Enterprise string Merchant size confidence
merchant_size_source Enterprise string Merchant size source
cross_border_cluster_size_range Enterprise string Cross-border cluster size range
Use include with comma-separated field names for smaller responses, for example include=domain,country,vat_number. Add include_meta=true only when you need request diagnostics, returned field names, credits, or freshness metadata in the JSON body.
Example response shape
{
  "object": "domain",
  "found": true,
  "domain": "aboutyou.com",
  "url": "https://aboutyou.com",
  "country": "Germany",
  "country_iso": "DE",
  "state": "Hamburg",
  "state_iso": "DE-HH",
  "city": null,
  "text_lang": "English",
  "is_ecommerce": true,
  "ecommerce_probability": 0.99,
  "primary_platform": "Custom",
  "platforms": ["Custom"],
  "category": "Clothing & Accessories",
  "categories": ["Clothing & Accessories"],
  "subcategory": "General clothing",
  "subcategories": ["General clothing", "Streetwear"],
  "subcategory_id": "general_clothing",
  "subcategory_ids": ["general_clothing", "streetwear"],
  "meta_title": "Online fashion from over 500 top brands | ABOUT YOU",
  "meta_description": "Order your fashion today at ABOUT YOU. Free and fast delivery.",
  "tech": ["React", "PWA", "Cloudflare", "PayPal", "HTTP/3"],
  "tech_version": ["HTTP/3"],
  "premium_tech": [],
  "tech_maturity_level": "Scaling",
  "estimated_monthly_tech_spend": 1482,
  "payment_providers": ["JCB", "MasterCard", "American Express", "PayPal", "Svea"],
  "shipping_carriers": ["Asendia"],
  "emails": [],
  "phones": ["+494083509377"],
  "website_year": 1996,
  "website_month": "1996-08",
  "commoncrawl_web_presence_bucket": "Very High",
  "commoncrawl_web_presence_trend_12m": "stable",
  "company_name": null,
  "vat_number": "339819462",
  "vat_country": "DE",
  "social": {
    "facebook": "https://www.facebook.com/aboutyouglobal/",
    "instagram": "https://www.instagram.com/aboutyou/",
    "linkedin": null,
    "pinterest": null,
    "tiktok": null,
    "twitter": null,
    "youtube": null
  },
  "store_age_tier": "10y_plus",
  "first_seen_year": 1996,
  "cross_border_countries": ["Austria", "Poland", "Sweden", "France"],
  "cross_border_domains": ["aboutyou.at", "aboutyou.pl", "aboutyou.se", "fr.aboutyou.ch"],
  "merchant_size_score": 100,
  "merchant_size_band": "top_1_percent",
  "merchant_size_country_score": 100,
  "merchant_size_country_band": "top_1_percent",
  "merchant_size_confidence": "high",
  "merchant_size_source": "reported",
  "cross_border_cluster_size_range": "25 - 100 related domains"
}

Metadata is optional. Request include_meta=true to add _meta.request_id, _meta.fields, _meta.credits_remaining, and data freshness values to the response body. The same request ID and credit usage are also returned in HTTP headers.

{
  "_meta": {
    "request_id": "01f3b41a-0ff6-4e0e-94d3-06a8e19d9892",
    "api_version": "v2",
    "plan": "premium",
    "fields": ["domain", "country", "tech"],
    "credits_cost": 1,
    "credits_remaining": 8743,
    "stack_observed_at": "2026-05-08T10:30:00.000Z",
    "stack_source": "techscan"
  }
}

Raw field catalog JSON is available at /api/v2/fields.

Unlock full access to ShopRank

Login now to explore merchant intelligence including:
  • Merchant size bands and scoring
  • PSP, carrier, and technology filters
  • Exports, saved lists, and API access
By login to our system you are accepting Terms & conditions and Privacy Policy