Pipispy API中文

Data usage rules: 1. Obtaining a data result consumes 1 data. Obtaining more detailed information about a data result does not consume data. 2. Ad Tracker: Each monitoring session costs $1/month. Each monitoring session is valid for one month and automatically expires after one month. Deleting a monitoring session does not restore the monitoring session, so please delete with caution. Monitoring sessions can be accessed at any time and are unlimited.

Store Traffic Ranking Data API Endpoint

API Information

  • API Name: Get Store Traffic Ranking Data
  • Request Method: POST
  • API Address: /open-api/v1/data
  • API Path: /v3/api/open/store/rank-data
  • API Description: Get traffic ranking data for a specified store's website, including global rank, country rank, category rank, and other information. Data is sourced from the third-party traffic analysis tool SimilarWeb, which can be used to evaluate a store website's traffic performance and industry position. Note: Not all stores have traffic ranking data. For websites with low traffic or newly established websites, empty data may be returned.
  • Pricing: Free

Request Headers:

  • Content-Type: application/json
  • Accept: application/json

Request Parameters

Request Structure

Parameter Type Description Example Required Default
key string External API request key "your_api_key_here" Yes
uri string API path "/v3/api/open/store/rank-data" Yes
params object API input parameters object See parameter list Yes

Request Body Parameters (params object)

Parameter Type Required Default Description
id String Yes - Store ID is a 13-character string (e.g., c2d5b2547218a), corresponding to the store_id field in the store rank list API response

Request Example

curl -X POST "https://www.pipispy.com/open-api/v1/data" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "key": "your_api_key_here",
    "uri": "/v3/api/open/store/rank-data",
    "params": {
        "id": "9407a696eb444"
    }
  }'

Response Parameters

Response Body Structure

{
  "code": 200,
  "message": "success",
  "data": {
    "data": {}
  },
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 0,
  "success": true,
  "fail": false
}

Response Field Descriptions

Field Type Description
code Integer Response status code, 200 means success
message String Response message description
data Object Response data body
data.data Object Store traffic ranking data object (SimilarWeb data)
version String API version number
timestamp String Response timestamp
sign String Response signature (reserved field)
remaining_credits Long Current remaining available credits after this request
consumed_credits Long Credits consumed by this request
success Boolean Whether the request was successful
fail Boolean Whether the request failed

Traffic Ranking Data Fields (data.data)

This object contains website traffic ranking data from SimilarWeb. Below are the complete field descriptions:

Basic Information Fields

Field Type Description
SiteName String Website domain. Pure domain without protocol header, such as "kuose.com"
Title String Website title. Extracted from the website HTML's <title> tag
Description String Website description. Brief description of website content, usually extracted from Meta Description
Category String Website category. Format is "primary category/secondary category", such as "lifestyle/fashion_and_apparel". Categories use lowercase letters and underscores as separators
LargeScreenshot String Website screenshot URL. Full CDN image address for displaying website homepage screenshot
SnapshotDate String Data snapshot date. ISO 8601 format datetime string indicating when this data was collected
Version Integer Data version number. Used to identify data format version
IsSmall Boolean Whether it's a small traffic website. true indicates low monthly visits (usually <5000), false indicates medium or high traffic website
IsDataFromGa Boolean Whether data is from Google Analytics. true means data is from GA, false means from SimilarWeb's own data sources
Policy Integer Policy identifier. Used internally to mark data processing strategies
update_time Long Data update time. Unix timestamp (seconds), indicating when data was last updated in the system
next_update_time Long Next update time. Unix timestamp (seconds), indicating estimated next data refresh time
Field Type Description
GlobalRank Object Global ranking object. Contains Rank field indicating the website's traffic rank among all websites globally. Lower number means higher rank. For example: {"Rank": 179954} means globally ranked 179,954th. This metric evaluates website's global influence
GlobalCategoryRank Object/Null Global category ranking object. Contains the website's ranking in a specific category globally. If the website hasn't been assigned a category ranking, it will be null
CategoryRank Object Category ranking object. Contains two fields: Category (category name, such as "Lifestyle/Fashion_and_Apparel") and Rank (ranking number within this category, such as "2409" means ranked 2409th in this category). This metric evaluates website's competitiveness in vertical domains
CountryRank Object Primary country ranking object. Contains three fields: Country (country code number, such as 840 for United States), Rank (ranking number in that country), CountryCode (ISO 3166-1 alpha-2 standard country code, such as "US"). Indicates the website's ranking in its primary traffic source country

Traffic and Visit Data Fields

Field Type Description
EstimatedMonthlyVisits Object Recent monthly visit trend object. Key is Unix timestamp (seconds), value is visit count for that month. Usually includes data for the most recent 3 months. For example: {"1754006400": 181479, "1756684800": 157196, "1759276800": 183701} indicates three months with visits of 181,479, 157,196, and 183,701 respectively
Engagments Object User engagement metrics object (note spelling as Engagments). Contains detailed user behavior data, see "User Engagement Fields" detailed description below
TrafficSources Object Traffic source distribution object. Contains traffic percentage from different channels, all channel percentages sum to 1.0. Detailed fields include:
- Direct: Direct traffic percentage (users directly entering URL or from bookmarks)
- Search: Search engine traffic percentage (from Google, Bing, etc.)
- Social: Social media traffic percentage (from Facebook, Instagram, TikTok, etc.)
- Referrals: Referral link traffic percentage (from links on other websites)
- Mail: Email traffic percentage (from email marketing links)
- Paid Referrals: Paid referral traffic percentage (from paid advertising links)
For example: {"Direct": "0.49163060258951263"} means 49.16% traffic is from direct visits
TopCountryShares Array[Object] Primary visitor country traffic distribution list. Contains the top 5 countries with most traffic to this website and their traffic percentages. Each object contains four fields:
- code: Country code (2 letters)
- Value: Traffic percentage (string format decimal, such as "0.5616358457921382" means 56.16%)
- Country: Country code (number)
- CountryCode: Country code (2 letters, same as code)
Traffic percentages usually sum to less than 1.0 because only top 5 countries are included
Countries Array[Object] Complete country list array. Contains all country information supported by SimilarWeb, each object includes UrlCode (URL-friendly country code), Code (ISO country code), Name (country name). This field is mainly for frontend country selectors, usually not needed

User Engagement Fields (Engagments object)

Field Type Description
Month String Data month. String from 1-12, such as "10" means October
Year String Data year. Four-digit string, such as "2025"
Visits String Total visits for that month. String format number, such as "183701" means 183,701 visits. This value is the same as the corresponding month in EstimatedMonthlyVisits
BounceRate String Bounce rate. String format decimal, range 0.0-1.0. Such as "0.38498812605523314" means 38.5% bounce rate. Bounce rate is the percentage of users who leave the website without any interaction after visiting. Lower value indicates better user stickiness
TimeOnSite String Average visit duration. String format number, unit is seconds. Such as "236.7671408104057" means average stay time is about 237 seconds (about 3 minutes 57 seconds). Longer duration indicates higher user interest in website content
PagePerVisit String Average pages per visit. String format number, such as "5.1769465367470895" means users visit an average of 5.18 pages. Higher value indicates higher user interest in website content and better website stickiness

SEO and Keyword Fields

Field Type Description
TopKeywords Array[Object] Website primary keywords list. Contains the top 5 keywords bringing most traffic to the website and their data. Each object contains four fields:
- Name: Keyword text, such as "kuose"
- Volume: Monthly search volume, indicating number of searches for this keyword per month
- Cpc: Cost per click, string format number (USD), such as "1.38". If no ad bidding data, it will be null
- EstimatedValue: Estimated traffic value, monthly traffic value (USD) estimated based on keyword search volume, ranking and CPC
This field can be used to analyze competitor's SEO strategy and core keywords

Competitor Fields

Field Type Description
Competitors Object Competitor data object. Contains TopSimilarityCompetitors field (array), listing competitor websites with highest similarity to this website. If array is empty, it means no competitor data is available

Notification Fields

Field Type Description
Notification Object Notification information object. Contains Content field, if there's any special notification or note for this website, it will be displayed in this field. Usually null

Important Notes:

  1. Data Availability: Not all stores have SimilarWeb data. For the following cases, data.data will return empty object {}:

    • Website traffic is too low (usually monthly visits less than 5000)
    • Newly established website (operating time less than 3 months)
    • Website not indexed by SimilarWeb
    • Invalid website domain corresponding to store ID
  2. Data Structure Dynamism: The data structure returned by SimilarWeb may change with its API version updates, the above field list is for reference only. Actual returned fields are based on response data.

  3. Data Timeliness: SimilarWeb data usually has 1-2 months delay, it's not real-time data. System updates ranking data once per week.

Response Examples

Example 1: Store with Traffic Ranking Data

{
  "code": 200,
  "message": "success",
  "data": {
    "Policy": 0,
    "Description": "KUOSE.com",
    "Category": "lifestyle/fashion_and_apparel",
    "TopKeywords": [
      {
        "Volume": 9820,
        "Cpc": "1.39",
        "EstimatedValue": 7640,
        "Name": "kuose"
      },
      {
        "Volume": 670,
        "Cpc": 1,
        "EstimatedValue": 580,
        "Name": "kuose clothing"
      },
      {
        "Volume": 510,
        "Cpc": "1.25",
        "EstimatedValue": 190,
        "Name": "kouse"
      },
      {
        "Volume": 190,
        "EstimatedValue": 180,
        "Name": "kurose clothing"
      },
      {
        "Volume": 150,
        "EstimatedValue": 150,
        "Name": "kuose white skirt"
      }
    ],
    "SiteName": "kuose.com",
    "TopCountryShares": [
      {
        "code": "US",
        "Value": "0.527240794320651",
        "Country": 840,
        "CountryCode": "US"
      },
      {
        "code": "KR",
        "Value": "0.09030019847364731",
        "Country": 410,
        "CountryCode": "KR"
      },
      {
        "code": "CA",
        "Value": "0.08972755877450395",
        "Country": 124,
        "CountryCode": "CA"
      },
      {
        "code": "AU",
        "Value": "0.05482726259335732",
        "Country": 36,
        "CountryCode": "AU"
      },
      {
        "code": "VN",
        "Value": "0.048566543892607804",
        "Country": 704,
        "CountryCode": "VN"
      }
    ],
    "CountryRank": {
      "Country": 840,
      "Rank": 82929,
      "CountryCode": "US"
    },
    "Countries": [
      {
        "UrlCode": "afghanistan",
        "Code": "AF",
        "Name": "Afghanistan"
      },
      {
        "UrlCode": "land-islands",
        "Code": "AX",
        "Name": "Åland Islands"
      },
      {
        "UrlCode": "albania",
        "Code": "AL",
        "Name": "Albania"
      },
      {
        "UrlCode": "algeria",
        "Code": "DZ",
        "Name": "Algeria"
      },
      {
        "UrlCode": "american-samoa",
        "Code": "AS",
        "Name": "American Samoa"
      },
      {
        "UrlCode": "andorra",
        "Code": "AD",
        "Name": "Andorra"
      },
      {
        "UrlCode": "angola",
        "Code": "AO",
        "Name": "Angola"
      },
      {
        "UrlCode": "anguilla",
        "Code": "AI",
        "Name": "Anguilla"
      },
      {
        "UrlCode": "antarctica",
        "Code": "AQ",
        "Name": "Antarctica"
      },
      {
        "UrlCode": "antigua-and-barbuda",
        "Code": "AG",
        "Name": "Antigua and Barbuda"
      },
      {
        "UrlCode": "argentina",
        "Code": "AR",
        "Name": "Argentina"
      },
      {
        "UrlCode": "armenia",
        "Code": "AM",
        "Name": "Armenia"
      },
      {
        "UrlCode": "aruba",
        "Code": "AW",
        "Name": "Aruba"
      },
      {
        "UrlCode": "australia",
        "Code": "AU",
        "Name": "Australia"
      },
      {
        "UrlCode": "austria",
        "Code": "AT",
        "Name": "Austria"
      },
      {
        "UrlCode": "azerbaijan",
        "Code": "AZ",
        "Name": "Azerbaijan"
      },
      {
        "UrlCode": "bahamas",
        "Code": "BS",
        "Name": "Bahamas"
      },
      {
        "UrlCode": "bahrain",
        "Code": "BH",
        "Name": "Bahrain"
      },
      {
        "UrlCode": "bangladesh",
        "Code": "BD",
        "Name": "Bangladesh"
      },
      {
        "UrlCode": "barbados",
        "Code": "BB",
        "Name": "Barbados"
      },
      {
        "UrlCode": "belarus",
        "Code": "BY",
        "Name": "Belarus"
      },
      {
        "UrlCode": "belgium",
        "Code": "BE",
        "Name": "Belgium"
      },
      {
        "UrlCode": "belize",
        "Code": "BZ",
        "Name": "Belize"
      },
      {
        "UrlCode": "benin",
        "Code": "BJ",
        "Name": "Benin"
      },
      {
        "UrlCode": "bermuda",
        "Code": "BM",
        "Name": "Bermuda"
      },
      {
        "UrlCode": "bhutan",
        "Code": "BT",
        "Name": "Bhutan"
      },
      {
        "UrlCode": "bolivia-plurinational-state-of",
        "Code": "BO",
        "Name": "Bolivia"
      },
      {
        "UrlCode": "bonaire-sint-eustatius-and-saba",
        "Code": "BQ",
        "Name": "Bonaire, Sint Eustatius and Saba"
      },
      {
        "UrlCode": "bosnia-and-herzegovina",
        "Code": "BA",
        "Name": "Bosnia and Herzegovina"
      },
      {
        "UrlCode": "botswana",
        "Code": "BW",
        "Name": "Botswana"
      },
      {
        "UrlCode": "bouvet-island",
        "Code": "BV",
        "Name": "Bouvet Island"
      },
      {
        "UrlCode": "brazil",
        "Code": "BR",
        "Name": "Brazil"
      },
      {
        "UrlCode": "british-indian-ocean-territory",
        "Code": "IO",
        "Name": "British Indian Ocean Territory"
      },
      {
        "UrlCode": "brunei-darussalam",
        "Code": "BN",
        "Name": "Brunei Darussalam"
      },
      {
        "UrlCode": "bulgaria",
        "Code": "BG",
        "Name": "Bulgaria"
      },
      {
        "UrlCode": "burkina-faso",
        "Code": "BF",
        "Name": "Burkina Faso"
      },
      {
        "UrlCode": "burundi",
        "Code": "BI",
        "Name": "Burundi"
      },
      {
        "UrlCode": "cabo-verde",
        "Code": "CV",
        "Name": "Cabo Verde"
      },
      {
        "UrlCode": "cambodia",
        "Code": "KH",
        "Name": "Cambodia"
      },
      {
        "UrlCode": "cameroon",
        "Code": "CM",
        "Name": "Cameroon"
      },
      {
        "UrlCode": "canada",
        "Code": "CA",
        "Name": "Canada"
      },
      {
        "UrlCode": "cayman-islands",
        "Code": "KY",
        "Name": "Cayman Islands"
      },
      {
        "UrlCode": "central-african-republic",
        "Code": "CF",
        "Name": "Central African Republic"
      },
      {
        "UrlCode": "chad",
        "Code": "TD",
        "Name": "Chad"
      },
      {
        "UrlCode": "chile",
        "Code": "CL",
        "Name": "Chile"
      },
      {
        "UrlCode": "china",
        "Code": "CN",
        "Name": "China"
      },
      {
        "UrlCode": "christmas-island",
        "Code": "CX",
        "Name": "Christmas Island"
      },
      {
        "UrlCode": "cocos-keeling-islands",
        "Code": "CC",
        "Name": "Cocos (Keeling) Islands"
      },
      {
        "UrlCode": "colombia",
        "Code": "CO",
        "Name": "Colombia"
      },
      {
        "UrlCode": "comoros",
        "Code": "KM",
        "Name": "Comoros"
      },
      {
        "UrlCode": "congo",
        "Code": "CG",
        "Name": "Congo"
      },
      {
        "UrlCode": "congo-the-democratic-republic-of-the",
        "Code": "CD",
        "Name": "Congo, the Democratic Republic of the"
      },
      {
        "UrlCode": "cook-islands",
        "Code": "CK",
        "Name": "Cook Islands"
      },
      {
        "UrlCode": "costa-rica",
        "Code": "CR",
        "Name": "Costa Rica"
      },
      {
        "UrlCode": "cte-divoire",
        "Code": "CI",
        "Name": "Côte d'Ivoire"
      },
      {
        "UrlCode": "croatia",
        "Code": "HR",
        "Name": "Croatia"
      },
      {
        "UrlCode": "cuba",
        "Code": "CU",
        "Name": "Cuba"
      },
      {
        "UrlCode": "curaao",
        "Code": "CW",
        "Name": "Curaçao"
      },
      {
        "UrlCode": "cyprus",
        "Code": "CY",
        "Name": "Cyprus"
      },
      {
        "UrlCode": "czech-republic",
        "Code": "CZ",
        "Name": "Czech Republic"
      },
      {
        "UrlCode": "denmark",
        "Code": "DK",
        "Name": "Denmark"
      },
      {
        "UrlCode": "djibouti",
        "Code": "DJ",
        "Name": "Djibouti"
      },
      {
        "UrlCode": "dominica",
        "Code": "DM",
        "Name": "Dominica"
      },
      {
        "UrlCode": "dominican-republic",
        "Code": "DO",
        "Name": "Dominican Republic"
      },
      {
        "UrlCode": "ecuador",
        "Code": "EC",
        "Name": "Ecuador"
      },
      {
        "UrlCode": "egypt",
        "Code": "EG",
        "Name": "Egypt"
      },
      {
        "UrlCode": "el-salvador",
        "Code": "SV",
        "Name": "El Salvador"
      },
      {
        "UrlCode": "equatorial-guinea",
        "Code": "GQ",
        "Name": "Equatorial Guinea"
      },
      {
        "UrlCode": "eritrea",
        "Code": "ER",
        "Name": "Eritrea"
      },
      {
        "UrlCode": "estonia",
        "Code": "EE",
        "Name": "Estonia"
      },
      {
        "UrlCode": "ethiopia",
        "Code": "ET",
        "Name": "Ethiopia"
      },
      {
        "UrlCode": "falkland-islands-malvinas",
        "Code": "FK",
        "Name": "Falkland Islands (Malvinas)"
      },
      {
        "UrlCode": "faroe-islands",
        "Code": "FO",
        "Name": "Faroe Islands"
      },
      {
        "UrlCode": "fiji",
        "Code": "FJ",
        "Name": "Fiji"
      },
      {
        "UrlCode": "finland",
        "Code": "FI",
        "Name": "Finland"
      },
      {
        "UrlCode": "france",
        "Code": "FR",
        "Name": "France"
      },
      {
        "UrlCode": "french-guiana",
        "Code": "GF",
        "Name": "French Guiana"
      },
      {
        "UrlCode": "french-polynesia",
        "Code": "PF",
        "Name": "French Polynesia"
      },
      {
        "UrlCode": "french-southern-territories",
        "Code": "TF",
        "Name": "French Southern Territories"
      },
      {
        "UrlCode": "gabon",
        "Code": "GA",
        "Name": "Gabon"
      },
      {
        "UrlCode": "gambia",
        "Code": "GM",
        "Name": "Gambia"
      },
      {
        "UrlCode": "georgia",
        "Code": "GE",
        "Name": "Georgia"
      },
      {
        "UrlCode": "germany",
        "Code": "DE",
        "Name": "Germany"
      },
      {
        "UrlCode": "ghana",
        "Code": "GH",
        "Name": "Ghana"
      },
      {
        "UrlCode": "gibraltar",
        "Code": "GI",
        "Name": "Gibraltar"
      },
      {
        "UrlCode": "greece",
        "Code": "GR",
        "Name": "Greece"
      },
      {
        "UrlCode": "greenland",
        "Code": "GL",
        "Name": "Greenland"
      },
      {
        "UrlCode": "grenada",
        "Code": "GD",
        "Name": "Grenada"
      },
      {
        "UrlCode": "guadeloupe",
        "Code": "GP",
        "Name": "Guadeloupe"
      },
      {
        "UrlCode": "guam",
        "Code": "GU",
        "Name": "Guam"
      },
      {
        "UrlCode": "guatemala",
        "Code": "GT",
        "Name": "Guatemala"
      },
      {
        "UrlCode": "guernsey",
        "Code": "GG",
        "Name": "Guernsey"
      },
      {
        "UrlCode": "guinea",
        "Code": "GN",
        "Name": "Guinea"
      },
      {
        "UrlCode": "guinea-bissau",
        "Code": "GW",
        "Name": "Guinea-Bissau"
      },
      {
        "UrlCode": "guyana",
        "Code": "GY",
        "Name": "Guyana"
      },
      {
        "UrlCode": "haiti",
        "Code": "HT",
        "Name": "Haiti"
      },
      {
        "UrlCode": "heard-island-and-mcdonald-islands",
        "Code": "HM",
        "Name": "Heard Island and McDonald Islands"
      },
      {
        "UrlCode": "holy-see-vatican-city-state",
        "Code": "VA",
        "Name": "Holy See (Vatican City State)"
      },
      {
        "UrlCode": "honduras",
        "Code": "HN",
        "Name": "Honduras"
      },
      {
        "UrlCode": "hong-kong",
        "Code": "HK",
        "Name": "Hong Kong"
      },
      {
        "UrlCode": "hungary",
        "Code": "HU",
        "Name": "Hungary"
      },
      {
        "UrlCode": "iceland",
        "Code": "IS",
        "Name": "Iceland"
      },
      {
        "UrlCode": "india",
        "Code": "IN",
        "Name": "India"
      },
      {
        "UrlCode": "indonesia",
        "Code": "ID",
        "Name": "Indonesia"
      },
      {
        "UrlCode": "iran-islamic-republic-of",
        "Code": "IR",
        "Name": "Iran"
      },
      {
        "UrlCode": "iraq",
        "Code": "IQ",
        "Name": "Iraq"
      },
      {
        "UrlCode": "ireland",
        "Code": "IE",
        "Name": "Ireland"
      },
      {
        "UrlCode": "isle-of-man",
        "Code": "IM",
        "Name": "Isle of Man"
      },
      {
        "UrlCode": "israel",
        "Code": "IL",
        "Name": "Israel"
      },
      {
        "UrlCode": "italy",
        "Code": "IT",
        "Name": "Italy"
      },
      {
        "UrlCode": "jamaica",
        "Code": "JM",
        "Name": "Jamaica"
      },
      {
        "UrlCode": "japan",
        "Code": "JP",
        "Name": "Japan"
      },
      {
        "UrlCode": "jersey",
        "Code": "JE",
        "Name": "Jersey"
      },
      {
        "UrlCode": "jordan",
        "Code": "JO",
        "Name": "Jordan"
      },
      {
        "UrlCode": "kazakhstan",
        "Code": "KZ",
        "Name": "Kazakhstan"
      },
      {
        "UrlCode": "kenya",
        "Code": "KE",
        "Name": "Kenya"
      },
      {
        "UrlCode": "kiribati",
        "Code": "KI",
        "Name": "Kiribati"
      },
      {
        "UrlCode": "korea-democratic-peoples-republic-of",
        "Code": "KP",
        "Name": "Korea, Democratic People's Republic of"
      },
      {
        "UrlCode": "korea-republic-of",
        "Code": "KR",
        "Name": "Korea, Republic of"
      },
      {
        "UrlCode": "kuwait",
        "Code": "KW",
        "Name": "Kuwait"
      },
      {
        "UrlCode": "kyrgyzstan",
        "Code": "KG",
        "Name": "Kyrgyzstan"
      },
      {
        "UrlCode": "lao-peoples-democratic-republic",
        "Code": "LA",
        "Name": "Lao People's Democratic Republic"
      },
      {
        "UrlCode": "latvia",
        "Code": "LV",
        "Name": "Latvia"
      },
      {
        "UrlCode": "lebanon",
        "Code": "LB",
        "Name": "Lebanon"
      },
      {
        "UrlCode": "lesotho",
        "Code": "LS",
        "Name": "Lesotho"
      },
      {
        "UrlCode": "liberia",
        "Code": "LR",
        "Name": "Liberia"
      },
      {
        "UrlCode": "libya",
        "Code": "LY",
        "Name": "Libya"
      },
      {
        "UrlCode": "liechtenstein",
        "Code": "LI",
        "Name": "Liechtenstein"
      },
      {
        "UrlCode": "lithuania",
        "Code": "LT",
        "Name": "Lithuania"
      },
      {
        "UrlCode": "luxembourg",
        "Code": "LU",
        "Name": "Luxembourg"
      },
      {
        "UrlCode": "macao",
        "Code": "MO",
        "Name": "Macao"
      },
      {
        "UrlCode": "macedonia-the-former-yugoslav-republic-of",
        "Code": "MK",
        "Name": "Macedonia (FYROM)"
      },
      {
        "UrlCode": "madagascar",
        "Code": "MG",
        "Name": "Madagascar"
      },
      {
        "UrlCode": "malawi",
        "Code": "MW",
        "Name": "Malawi"
      },
      {
        "UrlCode": "malaysia",
        "Code": "MY",
        "Name": "Malaysia"
      },
      {
        "UrlCode": "maldives",
        "Code": "MV",
        "Name": "Maldives"
      },
      {
        "UrlCode": "mali",
        "Code": "ML",
        "Name": "Mali"
      },
      {
        "UrlCode": "malta",
        "Code": "MT",
        "Name": "Malta"
      },
      {
        "UrlCode": "marshall-islands",
        "Code": "MH",
        "Name": "Marshall Islands"
      },
      {
        "UrlCode": "martinique",
        "Code": "MQ",
        "Name": "Martinique"
      },
      {
        "UrlCode": "mauritania",
        "Code": "MR",
        "Name": "Mauritania"
      },
      {
        "UrlCode": "mauritius",
        "Code": "MU",
        "Name": "Mauritius"
      },
      {
        "UrlCode": "mayotte",
        "Code": "YT",
        "Name": "Mayotte"
      },
      {
        "UrlCode": "mexico",
        "Code": "MX",
        "Name": "Mexico"
      },
      {
        "UrlCode": "micronesia-federated-states-of",
        "Code": "FM",
        "Name": "Micronesia, Federated States of"
      },
      {
        "UrlCode": "moldova-republic-of",
        "Code": "MD",
        "Name": "Moldova"
      },
      {
        "UrlCode": "monaco",
        "Code": "MC",
        "Name": "Monaco"
      },
      {
        "UrlCode": "mongolia",
        "Code": "MN",
        "Name": "Mongolia"
      },
      {
        "UrlCode": "montenegro",
        "Code": "ME",
        "Name": "Montenegro"
      },
      {
        "UrlCode": "montserrat",
        "Code": "MS",
        "Name": "Montserrat"
      },
      {
        "UrlCode": "morocco",
        "Code": "MA",
        "Name": "Morocco"
      },
      {
        "UrlCode": "mozambique",
        "Code": "MZ",
        "Name": "Mozambique"
      },
      {
        "UrlCode": "myanmar",
        "Code": "MM",
        "Name": "Myanmar"
      },
      {
        "UrlCode": "namibia",
        "Code": "NA",
        "Name": "Namibia"
      },
      {
        "UrlCode": "nauru",
        "Code": "NR",
        "Name": "Nauru"
      },
      {
        "UrlCode": "nepal",
        "Code": "NP",
        "Name": "Nepal"
      },
      {
        "UrlCode": "netherlands",
        "Code": "NL",
        "Name": "Netherlands"
      },
      {
        "UrlCode": "netherlands-antilles",
        "Code": "AN",
        "Name": "Netherlands Antilles"
      },
      {
        "UrlCode": "new-caledonia",
        "Code": "NC",
        "Name": "New Caledonia"
      },
      {
        "UrlCode": "new-zealand",
        "Code": "NZ",
        "Name": "New Zealand"
      },
      {
        "UrlCode": "nicaragua",
        "Code": "NI",
        "Name": "Nicaragua"
      },
      {
        "UrlCode": "niger",
        "Code": "NE",
        "Name": "Niger"
      },
      {
        "UrlCode": "nigeria",
        "Code": "NG",
        "Name": "Nigeria"
      },
      {
        "UrlCode": "niue",
        "Code": "NU",
        "Name": "Niue"
      },
      {
        "UrlCode": "non-spec-asia-pas-location",
        "Code": "AP",
        "Name": "Non-spec Asia Pas Location"
      },
      {
        "UrlCode": "norfolk-island",
        "Code": "NF",
        "Name": "Norfolk Island"
      },
      {
        "UrlCode": "northern-mariana-islands",
        "Code": "MP",
        "Name": "Northern Mariana Islands"
      },
      {
        "UrlCode": "norway",
        "Code": "NO",
        "Name": "Norway"
      },
      {
        "UrlCode": "oman",
        "Code": "OM",
        "Name": "Oman"
      },
      {
        "UrlCode": "pakistan",
        "Code": "PK",
        "Name": "Pakistan"
      },
      {
        "UrlCode": "palau",
        "Code": "PW",
        "Name": "Palau"
      },
      {
        "UrlCode": "palestine-state-of",
        "Code": "PS",
        "Name": "Palestine"
      },
      {
        "UrlCode": "panama",
        "Code": "PA",
        "Name": "Panama"
      },
      {
        "UrlCode": "papua-new-guinea",
        "Code": "PG",
        "Name": "Papua New Guinea"
      },
      {
        "UrlCode": "paraguay",
        "Code": "PY",
        "Name": "Paraguay"
      },
      {
        "UrlCode": "peru",
        "Code": "PE",
        "Name": "Peru"
      },
      {
        "UrlCode": "philippines",
        "Code": "PH",
        "Name": "Philippines"
      },
      {
        "UrlCode": "pitcairn",
        "Code": "PN",
        "Name": "Pitcairn"
      },
      {
        "UrlCode": "poland",
        "Code": "PL",
        "Name": "Poland"
      },
      {
        "UrlCode": "portugal",
        "Code": "PT",
        "Name": "Portugal"
      },
      {
        "UrlCode": "puerto-rico",
        "Code": "PR",
        "Name": "Puerto Rico"
      },
      {
        "UrlCode": "qatar",
        "Code": "QA",
        "Name": "Qatar"
      },
      {
        "UrlCode": "runion",
        "Code": "RE",
        "Name": "Réunion"
      },
      {
        "UrlCode": "romania",
        "Code": "RO",
        "Name": "Romania"
      },
      {
        "UrlCode": "russian-federation",
        "Code": "RU",
        "Name": "Russia"
      },
      {
        "UrlCode": "rwanda",
        "Code": "RW",
        "Name": "Rwanda"
      },
      {
        "UrlCode": "saint-barthlemy",
        "Code": "BL",
        "Name": "Saint Barthélemy"
      },
      {
        "UrlCode": "saint-helena-ascension-and-tristan-da-cunha",
        "Code": "SH",
        "Name": "Saint Helena, Ascension and Tristan da Cunha"
      },
      {
        "UrlCode": "saint-kitts-and-nevis",
        "Code": "KN",
        "Name": "Saint Kitts and Nevis"
      },
      {
        "UrlCode": "saint-lucia",
        "Code": "LC",
        "Name": "Saint Lucia"
      },
      {
        "UrlCode": "saint-martin-french-part",
        "Code": "MF",
        "Name": "Saint Martin (French part)"
      },
      {
        "UrlCode": "saint-pierre-and-miquelon",
        "Code": "PM",
        "Name": "Saint Pierre and Miquelon"
      },
      {
        "UrlCode": "saint-vincent-and-the-grenadines",
        "Code": "VC",
        "Name": "Saint Vincent and the Grenadines"
      },
      {
        "UrlCode": "samoa",
        "Code": "WS",
        "Name": "Samoa"
      },
      {
        "UrlCode": "san-marino",
        "Code": "SM",
        "Name": "San Marino"
      },
      {
        "UrlCode": "sao-tome-and-principe",
        "Code": "ST",
        "Name": "Sao Tome and Principe"
      },
      {
        "UrlCode": "saudi-arabia",
        "Code": "SA",
        "Name": "Saudi Arabia"
      },
      {
        "UrlCode": "senegal",
        "Code": "SN",
        "Name": "Senegal"
      },
      {
        "UrlCode": "serbia",
        "Code": "RS",
        "Name": "Serbia"
      },
      {
        "UrlCode": "serbia-and-montenegro",
        "Code": "CS",
        "Name": "SERBIA AND MONTENEGRO"
      },
      {
        "UrlCode": "seychelles",
        "Code": "SC",
        "Name": "Seychelles"
      },
      {
        "UrlCode": "sierra-leone",
        "Code": "SL",
        "Name": "Sierra Leone"
      },
      {
        "UrlCode": "singapore",
        "Code": "SG",
        "Name": "Singapore"
      },
      {
        "UrlCode": "sint-maarten-dutch-part",
        "Code": "SX",
        "Name": "Sint Maarten (Dutch part)"
      },
      {
        "UrlCode": "slovakia",
        "Code": "SK",
        "Name": "Slovakia"
      },
      {
        "UrlCode": "slovenia",
        "Code": "SI",
        "Name": "Slovenia"
      },
      {
        "UrlCode": "solomon-islands",
        "Code": "SB",
        "Name": "Solomon Islands"
      },
      {
        "UrlCode": "somalia",
        "Code": "SO",
        "Name": "Somalia"
      },
      {
        "UrlCode": "south-africa",
        "Code": "ZA",
        "Name": "South Africa"
      },
      {
        "UrlCode": "south-georgia-and-the-south-sandwich-islands",
        "Code": "GS",
        "Name": "South Georgia and the South Sandwich Islands"
      },
      {
        "UrlCode": "south-sudan",
        "Code": "SS",
        "Name": "South Sudan"
      },
      {
        "UrlCode": "spain",
        "Code": "ES",
        "Name": "Spain"
      },
      {
        "UrlCode": "sri-lanka",
        "Code": "LK",
        "Name": "Sri Lanka"
      },
      {
        "UrlCode": "sudan",
        "Code": "SD",
        "Name": "Sudan"
      },
      {
        "UrlCode": "suriname",
        "Code": "SR",
        "Name": "Suriname"
      },
      {
        "UrlCode": "svalbard-and-jan-mayen",
        "Code": "SJ",
        "Name": "Svalbard and Jan Mayen"
      },
      {
        "UrlCode": "swaziland",
        "Code": "SZ",
        "Name": "Swaziland"
      },
      {
        "UrlCode": "sweden",
        "Code": "SE",
        "Name": "Sweden"
      },
      {
        "UrlCode": "switzerland",
        "Code": "CH",
        "Name": "Switzerland"
      },
      {
        "UrlCode": "syrian-arab-republic",
        "Code": "SY",
        "Name": "Syrian Arab Republic"
      },
      {
        "UrlCode": "taiwan",
        "Code": "TW",
        "Name": "Taiwan"
      },
      {
        "UrlCode": "tajikistan",
        "Code": "TJ",
        "Name": "Tajikistan"
      },
      {
        "UrlCode": "tanzania-united-republic-of",
        "Code": "TZ",
        "Name": "Tanzania, United Republic of"
      },
      {
        "UrlCode": "thailand",
        "Code": "TH",
        "Name": "Thailand"
      },
      {
        "UrlCode": "timor-leste",
        "Code": "TL",
        "Name": "Timor-Leste"
      },
      {
        "UrlCode": "togo",
        "Code": "TG",
        "Name": "Togo"
      },
      {
        "UrlCode": "tokelau",
        "Code": "TK",
        "Name": "Tokelau"
      },
      {
        "UrlCode": "tonga",
        "Code": "TO",
        "Name": "Tonga"
      },
      {
        "UrlCode": "trinidad-and-tobago",
        "Code": "TT",
        "Name": "Trinidad and Tobago"
      },
      {
        "UrlCode": "tunisia",
        "Code": "TN",
        "Name": "Tunisia"
      },
      {
        "UrlCode": "turkey",
        "Code": "TR",
        "Name": "Turkey"
      },
      {
        "UrlCode": "turkmenistan",
        "Code": "TM",
        "Name": "Turkmenistan"
      },
      {
        "UrlCode": "turks-and-caicos-islands",
        "Code": "TC",
        "Name": "Turks and Caicos Islands"
      },
      {
        "UrlCode": "tuvalu",
        "Code": "TV",
        "Name": "Tuvalu"
      },
      {
        "UrlCode": "uganda",
        "Code": "UG",
        "Name": "Uganda"
      },
      {
        "UrlCode": "ukraine",
        "Code": "UA",
        "Name": "Ukraine"
      },
      {
        "UrlCode": "united-arab-emirates",
        "Code": "AE",
        "Name": "United Arab Emirates"
      },
      {
        "UrlCode": "united-kingdom",
        "Code": "GB",
        "Name": "United Kingdom"
      },
      {
        "UrlCode": "united-states",
        "Code": "US",
        "Name": "United States"
      },
      {
        "UrlCode": "united-states-minor-outlying-islands",
        "Code": "UM",
        "Name": "United States Minor Outlying Islands"
      },
      {
        "UrlCode": "uruguay",
        "Code": "UY",
        "Name": "Uruguay"
      },
      {
        "UrlCode": "uzbekistan",
        "Code": "UZ",
        "Name": "Uzbekistan"
      },
      {
        "UrlCode": "vanuatu",
        "Code": "VU",
        "Name": "Vanuatu"
      },
      {
        "UrlCode": "venezuela-bolivarian-republic-of",
        "Code": "VE",
        "Name": "Venezuela"
      },
      {
        "UrlCode": "vietnam",
        "Code": "VN",
        "Name": "Vietnam"
      },
      {
        "UrlCode": "virgin-islands-british",
        "Code": "VG",
        "Name": "Virgin Islands, British"
      },
      {
        "UrlCode": "virgin-islands-us",
        "Code": "VI",
        "Name": "Virgin Islands, U.S."
      },
      {
        "UrlCode": "wallis-and-futuna",
        "Code": "WF",
        "Name": "Wallis and Futuna"
      },
      {
        "UrlCode": "western-sahara",
        "Code": "EH",
        "Name": "Western Sahara"
      },
      {
        "UrlCode": "yemen",
        "Code": "YE",
        "Name": "Yemen"
      },
      {
        "UrlCode": "zambia",
        "Code": "ZM",
        "Name": "Zambia"
      },
      {
        "UrlCode": "zimbabwe",
        "Code": "ZW",
        "Name": "Zimbabwe"
      }
    ],
    "next_update_time": 1764214104,
    "Title": "KUOSE.com",
    "Engagments": {
      "BounceRate": "0.3658702925231566",
      "Month": "9",
      "Year": "2025",
      "Visits": "157196",
      "TimeOnSite": "171.18898233918964",
      "PagePerVisit": "5.183859363385903"
    },
    "SnapshotDate": "2025-09-01T00:00:00+00:00",
    "EstimatedMonthlyVisits": {
      "1754006400": 181479,
      "1756684800": 157196,
      "1751328000": 124874
    },
    "GlobalRank": {
      "Rank": 188495
    },
    "Notification": {},
    "update_time": 1761622104,
    "Version": 1,
    "IsSmall": false,
    "TrafficSources": {
      "Social": "0.09741661361619032",
      "Mail": "0.001184550837573985",
      "Referrals": "0.03595114837028244",
      "Search": "0.37041352611386147",
      "Paid Referrals": "0.0056197611782149055",
      "Direct": "0.4894143998836085"
    },
    "CategoryRank": {
      "Category": "Lifestyle/Fashion_and_Apparel",
      "Rank": "2437"
    },
    "LargeScreenshot": "https://site-images.similarcdn.com/image?url=kuose.com&t=1&s=1&h=3b1b8c98a661481ba356795b6c9d886c6d65780d1f71757ee379b18b995ecd31",
    "Competitors": {
      "TopSimilarityCompetitors": []
    },
    "IsDataFromGa": false
  },
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 0,
  "success": true,
  "fail": false
}

Note: To simplify the display, the above example omits the Countries field (the complete country list contains 200+ country objects).

Example 2: Store without Traffic Ranking Data

{
  "code": 200,
  "message": "success",
  "data": {},
  "version": "v1",
  "timestamp": null,
  "sign": null,
  "remaining_credits": 9980,
  "consumed_credits": 0,
  "success": true,
  "fail": false
}

Error Code Descriptions

Error Code Description Solution
200 Success -
400 Request parameter error Check if id format is correct
401 Unauthorized Check if API Key is valid and not expired
403 Insufficient permissions Check if API Key has permission to access this endpoint
404 Store does not exist Check if id is correct, whether the store has been deleted from the system
500 Internal server error Contact technical support or retry later