{"name":"綠界大數據 ECPAYDATA Public API Catalog","version":"2026-06-09","docs":{"home":"/developers","openapi":"/api/docs/openapi.json","llms":"/llms.txt","mcp":"/api/mcp"},"docsMcpTools":["docs.search","docs.get_page","api.list_endpoints","api.get_endpoint","api.get_openapi","api.get_changelog"],"groups":[{"id":"meta","title":"Meta","description":"分類探索與後續查詢前置資料。"},{"id":"overview","title":"Overview","description":"整體交易趨勢、排行、成長率與付款方式。"},{"id":"market","title":"Market","description":"主分類市場分析資料。"},{"id":"sub-market","title":"Sub-market","description":"子分類品項分析資料。"}],"endpoints":[{"id":"meta.categories","group":"meta","title":"主分類清單","description":"取得目前可用的主分類名稱，建議作為所有分類型 API 的第一步。","method":"GET","path":"/api/public/meta/categories","queryParams":[],"examplePath":"/api/public/meta/categories","usagePoints":1,"fixedUsage":true,"mcpToolName":"meta.categories","mcpDescription":"取得目前可用的主分類清單。","responseSummary":[{"name":"code","type":"number","description":"固定為 200。"},{"name":"data.categories[]","type":"string[]","description":"主分類名稱清單。"}]},{"id":"meta.sub_categories","group":"meta","title":"子分類清單","description":"取得指定主分類底下的子分類名稱。","method":"GET","path":"/api/public/meta/sub-categories","queryParams":[{"name":"category","type":"string","required":false,"description":"主分類名稱。未提供或無效時會使用系統預設主分類。","example":"美妝保養"}],"examplePath":"/api/public/meta/sub-categories?category=美妝保養","usagePoints":1,"fixedUsage":true,"mcpToolName":"meta.sub_categories","mcpDescription":"取得指定主分類底下的子分類清單。","responseSummary":[{"name":"code","type":"number","description":"固定為 200。"},{"name":"data.category","type":"string","description":"實際使用的主分類名稱。"},{"name":"data.subCategories[]","type":"string[]","description":"子分類名稱清單。"}]},{"id":"trends.overview","group":"overview","title":"Overview 趨勢","description":"取得整體週度交易趨勢，適合用於首頁總覽面積圖。","method":"GET","path":"/api/public/trends/overview","queryParams":[],"examplePath":"/api/public/trends/overview","usagePoints":40,"mcpToolName":"trends.overview","mcpDescription":"取得整體 overview 週度交易趨勢。","responseSummary":[{"name":"code","type":"number","description":"固定為 200。"},{"name":"data.type","type":"string","description":"資料類型識別值。"},{"name":"data.granularity","type":"string","description":"趨勢粒度；週聚合可用時為 week，尚未建立或刷新時暫回退為 month。"},{"name":"data.start","type":"string","description":"回應資料涵蓋的起始日期。"},{"name":"data.end","type":"string","description":"回應資料涵蓋的結束日期。"},{"name":"data.trend[].month","type":"string","description":"週區間標籤，格式為 MM/DD-MM/DD；欄位名保留為 month 以相容既有客戶端。"},{"name":"data.trend[].week_start","type":"string","description":"週度資料的完整週起始日，格式為 YYYY-MM-DD；月度 fallback 不提供。"},{"name":"data.trend[].week_end","type":"string","description":"週度資料的完整週結束日，格式為 YYYY-MM-DD；月度 fallback 不提供。"},{"name":"data.trend[].total_amount","type":"number","description":"該週交易金額。"},{"name":"data.trend[].trade_count","type":"number","description":"該週交易筆數。"},{"name":"data.trend[].avg_amount","type":"number","description":"該週平均客單價。"}]},{"id":"overview.ranking","group":"overview","title":"Overview 排行","description":"取得首頁主分類交易排行，包含金額、筆數、客單與熱門子分類。","method":"GET","path":"/api/public/overview/ranking","queryParams":[],"examplePath":"/api/public/overview/ranking","usagePoints":30,"mcpToolName":"overview.ranking","mcpDescription":"取得首頁主分類交易排行。","responseSummary":[{"name":"code","type":"number","description":"固定為 200。"},{"name":"data.type","type":"string","description":"資料類型識別值。"},{"name":"data.start","type":"string","description":"回應資料涵蓋的起始日期。"},{"name":"data.end","type":"string","description":"回應資料涵蓋的結束日期。"},{"name":"data.items[].name","type":"string","description":"分類或付款方式名稱。"},{"name":"data.items[].total_amount","type":"number","description":"交易金額。"},{"name":"data.items[].trade_count","type":"number","description":"交易筆數。"},{"name":"data.items[].avg_amount","type":"number","description":"平均客單價。"},{"name":"data.items[].producttypename","type":"string","description":"主分類名稱。"},{"name":"data.items[].top_subs[]","type":"string[]","description":"該主分類熱門子分類。"}]},{"id":"overview.growth","group":"overview","title":"Overview 成長率","description":"取得主分類金額與筆數成長率排行。","method":"GET","path":"/api/public/overview/growth","queryParams":[],"examplePath":"/api/public/overview/growth","usagePoints":40,"mcpToolName":"overview.growth","mcpDescription":"取得首頁主分類成長率排行。","responseSummary":[{"name":"code","type":"number","description":"固定為 200。"},{"name":"data.type","type":"string","description":"固定為 overview-growth。"},{"name":"data.items[].producttypename","type":"string","description":"主分類名稱。"},{"name":"data.items[].current_amount","type":"number","description":"目前區間交易金額。"},{"name":"data.items[].previous_amount","type":"number","description":"前一比較區間交易金額。"},{"name":"data.items[].growth_rate","type":"number","description":"金額成長率。"},{"name":"data.items[].current_count","type":"number","description":"目前區間交易筆數。"},{"name":"data.items[].count_growth_rate","type":"number","description":"筆數成長率。"}]},{"id":"overview.payment","group":"overview","title":"Overview 付款方式","description":"取得首頁付款方式分佈。","method":"GET","path":"/api/public/overview/payment","queryParams":[],"examplePath":"/api/public/overview/payment","usagePoints":20,"mcpToolName":"overview.payment","mcpDescription":"取得首頁付款方式分佈。","responseSummary":[{"name":"code","type":"number","description":"固定為 200。"},{"name":"data.type","type":"string","description":"資料類型識別值。"},{"name":"data.start","type":"string","description":"回應資料涵蓋的起始日期。"},{"name":"data.end","type":"string","description":"回應資料涵蓋的結束日期。"},{"name":"data.items[].name","type":"string","description":"付款方式名稱。"},{"name":"data.items[].count","type":"number","description":"交易筆數。"},{"name":"data.items[].percent","type":"string","description":"該付款方式佔比。"}]},{"id":"trends.market","group":"market","title":"Market 趨勢","description":"取得主分類市場的週度交易趨勢。","method":"GET","path":"/api/public/trends/market","queryParams":[{"name":"category","type":"string","required":false,"description":"主分類名稱。未提供或無效時會使用系統預設主分類。","example":"美妝保養"},{"name":"start","type":"string","required":false,"description":"查詢起始日期，格式為 YYYY-MM-DD。","example":"2025-07-01"},{"name":"end","type":"string","required":false,"description":"查詢結束日期，格式為 YYYY-MM-DD。","example":"2025-12-26"}],"examplePath":"/api/public/trends/market?category=美妝保養&start=2025-07-01&end=2025-12-26","usagePoints":50,"mcpToolName":"trends.market","mcpDescription":"取得指定主分類的週度交易趨勢。","responseSummary":[{"name":"code","type":"number","description":"固定為 200。"},{"name":"data.type","type":"string","description":"資料類型識別值。"},{"name":"data.granularity","type":"string","description":"趨勢粒度；週聚合可用時為 week，尚未建立或刷新時暫回退為 month。"},{"name":"data.start","type":"string","description":"回應資料涵蓋的起始日期。"},{"name":"data.end","type":"string","description":"回應資料涵蓋的結束日期。"},{"name":"data.trend[].month","type":"string","description":"週區間標籤，格式為 MM/DD-MM/DD；欄位名保留為 month 以相容既有客戶端。"},{"name":"data.trend[].week_start","type":"string","description":"週度資料的完整週起始日，格式為 YYYY-MM-DD；月度 fallback 不提供。"},{"name":"data.trend[].week_end","type":"string","description":"週度資料的完整週結束日，格式為 YYYY-MM-DD；月度 fallback 不提供。"},{"name":"data.trend[].total_amount","type":"number","description":"該週交易金額。"},{"name":"data.trend[].trade_count","type":"number","description":"該週交易筆數。"},{"name":"data.trend[].avg_amount","type":"number","description":"該週平均客單價。"},{"name":"data.category","type":"string","description":"實際使用的主分類名稱。"}]},{"id":"market.sub_ranking","group":"market","title":"Market 子分類排行","description":"取得指定主分類底下的子分類交易排行。","method":"GET","path":"/api/public/market/sub-ranking","queryParams":[{"name":"category","type":"string","required":false,"description":"主分類名稱。未提供或無效時會使用系統預設主分類。","example":"美妝保養"},{"name":"start","type":"string","required":false,"description":"查詢起始日期，格式為 YYYY-MM-DD。","example":"2025-07-01"},{"name":"end","type":"string","required":false,"description":"查詢結束日期，格式為 YYYY-MM-DD。","example":"2025-12-26"}],"examplePath":"/api/public/market/sub-ranking?category=美妝保養&start=2025-07-01&end=2025-12-26","usagePoints":35,"mcpToolName":"market.sub_ranking","mcpDescription":"取得指定主分類底下的子分類交易排行。","responseSummary":[{"name":"code","type":"number","description":"固定為 200。"},{"name":"data.type","type":"string","description":"資料類型識別值。"},{"name":"data.start","type":"string","description":"回應資料涵蓋的起始日期。"},{"name":"data.end","type":"string","description":"回應資料涵蓋的結束日期。"},{"name":"data.items[].name","type":"string","description":"分類或付款方式名稱。"},{"name":"data.items[].total_amount","type":"number","description":"交易金額。"},{"name":"data.items[].trade_count","type":"number","description":"交易筆數。"},{"name":"data.items[].avg_amount","type":"number","description":"平均客單價。"},{"name":"data.category","type":"string","description":"實際使用的主分類名稱。"}]},{"id":"market.payment","group":"market","title":"Market 付款方式","description":"取得指定主分類的付款方式分佈。","method":"GET","path":"/api/public/market/payment","queryParams":[{"name":"category","type":"string","required":false,"description":"主分類名稱。未提供或無效時會使用系統預設主分類。","example":"美妝保養"},{"name":"start","type":"string","required":false,"description":"查詢起始日期，格式為 YYYY-MM-DD。","example":"2025-07-01"},{"name":"end","type":"string","required":false,"description":"查詢結束日期，格式為 YYYY-MM-DD。","example":"2025-12-26"}],"examplePath":"/api/public/market/payment?category=美妝保養&start=2025-07-01&end=2025-12-26","usagePoints":25,"mcpToolName":"market.payment","mcpDescription":"取得指定主分類的付款方式分佈。","responseSummary":[{"name":"code","type":"number","description":"固定為 200。"},{"name":"data.type","type":"string","description":"資料類型識別值。"},{"name":"data.start","type":"string","description":"回應資料涵蓋的起始日期。"},{"name":"data.end","type":"string","description":"回應資料涵蓋的結束日期。"},{"name":"data.items[].name","type":"string","description":"付款方式名稱。"},{"name":"data.items[].count","type":"number","description":"交易筆數。"},{"name":"data.items[].percent","type":"string","description":"該付款方式佔比。"},{"name":"data.category","type":"string","description":"實際使用的主分類名稱。"}]},{"id":"market.focus","group":"market","title":"Market 數據焦點","description":"取得指定主分類的人維度與交易焦點指標。其中 tradeCount、totalAmount、avgAmount 為目前查詢區間的全付款方式交易口徑；audienceCount、frequency、arpu 僅統計信用卡、信用卡分期與銀聯且具會員識別的訂單。","method":"GET","path":"/api/public/market/focus","queryParams":[{"name":"category","type":"string","required":false,"description":"主分類名稱。未提供或無效時會使用系統預設主分類。","example":"美妝保養"},{"name":"start","type":"string","required":false,"description":"查詢起始日期，格式為 YYYY-MM-DD。","example":"2025-07-01"},{"name":"end","type":"string","required":false,"description":"查詢結束日期，格式為 YYYY-MM-DD。","example":"2025-12-26"}],"examplePath":"/api/public/market/focus?category=美妝保養&start=2025-07-01&end=2025-12-26","usagePoints":45,"mcpToolName":"market.focus","mcpDescription":"取得指定主分類的人維度與交易焦點指標。其中 tradeCount、totalAmount、avgAmount 為目前查詢區間的全付款方式交易口徑；audienceCount、frequency、arpu 僅統計信用卡、信用卡分期與銀聯且具會員識別的訂單。","responseSummary":[{"name":"code","type":"number","description":"固定為 200。"},{"name":"data.type","type":"string","description":"資料類型識別值。"},{"name":"data.category","type":"string","description":"主分類名稱。"},{"name":"data.start","type":"string","description":"回應資料涵蓋的起始日期。"},{"name":"data.end","type":"string","description":"回應資料涵蓋的結束日期。"},{"name":"data.focus","type":"object","description":"目前區間的人維度與交易焦點指標。其中 tradeCount、totalAmount、avgAmount 為目前查詢區間的全付款方式交易口徑；audienceCount、frequency、arpu 僅統計信用卡、信用卡分期與銀聯且具會員識別的訂單。"},{"name":"data.prevFocus","type":"object|null","description":"前一比較區間的人維度與交易焦點指標；若該 endpoint 未提供比較期則為 null。其中 tradeCount、totalAmount、avgAmount 為目前查詢區間的全付款方式交易口徑；audienceCount、frequency、arpu 僅統計信用卡、信用卡分期與銀聯且具會員識別的訂單。"}]},{"id":"trends.sub_market","group":"sub-market","title":"Sub-market 趨勢","description":"取得指定子分類的週度交易趨勢。","method":"GET","path":"/api/public/trends/sub-market","queryParams":[{"name":"category","type":"string","required":false,"description":"主分類名稱。未提供或無效時會使用系統預設主分類。","example":"美妝保養"},{"name":"sub","type":"string","required":false,"description":"子分類名稱。未提供或無效時會使用系統預設子分類。","example":"精華液"},{"name":"start","type":"string","required":false,"description":"查詢起始日期，格式為 YYYY-MM-DD。","example":"2025-07-01"},{"name":"end","type":"string","required":false,"description":"查詢結束日期，格式為 YYYY-MM-DD。","example":"2025-12-26"}],"examplePath":"/api/public/trends/sub-market?category=美妝保養&sub=精華液&start=2025-07-01&end=2025-12-26","usagePoints":60,"mcpToolName":"trends.sub_market","mcpDescription":"取得指定子分類的週度交易趨勢。","responseSummary":[{"name":"code","type":"number","description":"固定為 200。"},{"name":"data.type","type":"string","description":"資料類型識別值。"},{"name":"data.granularity","type":"string","description":"趨勢粒度；週聚合可用時為 week，尚未建立或刷新時暫回退為 month。"},{"name":"data.start","type":"string","description":"回應資料涵蓋的起始日期。"},{"name":"data.end","type":"string","description":"回應資料涵蓋的結束日期。"},{"name":"data.trend[].month","type":"string","description":"週區間標籤，格式為 MM/DD-MM/DD；欄位名保留為 month 以相容既有客戶端。"},{"name":"data.trend[].week_start","type":"string","description":"週度資料的完整週起始日，格式為 YYYY-MM-DD；月度 fallback 不提供。"},{"name":"data.trend[].week_end","type":"string","description":"週度資料的完整週結束日，格式為 YYYY-MM-DD；月度 fallback 不提供。"},{"name":"data.trend[].total_amount","type":"number","description":"該週交易金額。"},{"name":"data.trend[].trade_count","type":"number","description":"該週交易筆數。"},{"name":"data.trend[].avg_amount","type":"number","description":"該週平均客單價。"},{"name":"data.category","type":"string","description":"實際使用的主分類名稱。"},{"name":"data.subCategory","type":"string","description":"實際使用的子分類名稱。"}]},{"id":"sub_market.focus","group":"sub-market","title":"Sub-market 數據焦點","description":"取得指定子分類的人維度與交易焦點指標。其中 tradeCount、totalAmount、avgAmount 為目前查詢區間的全付款方式交易口徑；audienceCount、frequency、arpu 僅統計信用卡、信用卡分期與銀聯且具會員識別的訂單。","method":"GET","path":"/api/public/sub-market/focus","queryParams":[{"name":"category","type":"string","required":false,"description":"主分類名稱。未提供或無效時會使用系統預設主分類。","example":"美妝保養"},{"name":"sub","type":"string","required":false,"description":"子分類名稱。未提供或無效時會使用系統預設子分類。","example":"精華液"},{"name":"start","type":"string","required":false,"description":"查詢起始日期，格式為 YYYY-MM-DD。","example":"2025-07-01"},{"name":"end","type":"string","required":false,"description":"查詢結束日期，格式為 YYYY-MM-DD。","example":"2025-12-26"}],"examplePath":"/api/public/sub-market/focus?category=美妝保養&sub=精華液&start=2025-07-01&end=2025-12-26","usagePoints":65,"mcpToolName":"sub_market.focus","mcpDescription":"取得指定子分類的人維度與交易焦點指標。其中 tradeCount、totalAmount、avgAmount 為目前查詢區間的全付款方式交易口徑；audienceCount、frequency、arpu 僅統計信用卡、信用卡分期與銀聯且具會員識別的訂單。","responseSummary":[{"name":"code","type":"number","description":"固定為 200。"},{"name":"data.type","type":"string","description":"資料類型識別值。"},{"name":"data.category","type":"string","description":"主分類名稱。"},{"name":"data.start","type":"string","description":"回應資料涵蓋的起始日期。"},{"name":"data.end","type":"string","description":"回應資料涵蓋的結束日期。"},{"name":"data.focus","type":"object","description":"目前區間的人維度與交易焦點指標。其中 tradeCount、totalAmount、avgAmount 為目前查詢區間的全付款方式交易口徑；audienceCount、frequency、arpu 僅統計信用卡、信用卡分期與銀聯且具會員識別的訂單。"},{"name":"data.prevFocus","type":"object|null","description":"前一比較區間的人維度與交易焦點指標；若該 endpoint 未提供比較期則為 null。其中 tradeCount、totalAmount、avgAmount 為目前查詢區間的全付款方式交易口徑；audienceCount、frequency、arpu 僅統計信用卡、信用卡分期與銀聯且具會員識別的訂單。"},{"name":"data.subCategory","type":"string","description":"實際使用的子分類名稱。"}]},{"id":"sub_market.tags","group":"sub-market","title":"Sub-market 常見商品標籤","description":"取得指定子分類在指定期間內有成交商品的常見標籤 Top 10 與覆蓋率；標籤可重疊，百分比不一定加總為 100%。","method":"GET","path":"/api/public/sub-market/tags","queryParams":[{"name":"category","type":"string","required":false,"description":"主分類名稱。未提供或無效時會使用系統預設主分類。","example":"美妝保養"},{"name":"sub","type":"string","required":false,"description":"子分類名稱。未提供或無效時會使用系統預設子分類。","example":"精華液"},{"name":"start","type":"string","required":false,"description":"查詢起始日期，格式為 YYYY-MM-DD。","example":"2025-07-01"},{"name":"end","type":"string","required":false,"description":"查詢結束日期，格式為 YYYY-MM-DD。","example":"2025-12-26"}],"examplePath":"/api/public/sub-market/tags?category=3C周邊&sub=平板&start=2025-07-01&end=2025-12-26","usagePoints":100,"mcpToolName":"sub_market.tags","mcpDescription":"取得指定子分類在指定期間內有成交商品的常見標籤 Top 10 與覆蓋率；標籤可重疊，百分比不一定加總為 100%。","responseSummary":[{"name":"code","type":"number","description":"固定為 200。"},{"name":"data.type","type":"string","description":"固定為 sub-market-tags。"},{"name":"data.category","type":"string","description":"實際使用的主分類名稱。"},{"name":"data.subCategory","type":"string","description":"實際使用的子分類名稱。"},{"name":"data.start","type":"string","description":"回應資料涵蓋的起始日期。"},{"name":"data.end","type":"string","description":"回應資料涵蓋的結束日期。"},{"name":"data.items[].key","type":"string","description":"TAG 維度名稱，例如 類型、功能。"},{"name":"data.items[].value","type":"string","description":"TAG 值。"},{"name":"data.items[].count","type":"number","description":"指定期間內有成交，且帶有此標籤的商品數。"},{"name":"data.items[].percent","type":"number","description":"指定期間內有成交且具任一標籤商品中的覆蓋率；標籤可重疊，因此不一定加總為 100。"}]},{"id":"sub_market.related_purchases","group":"sub-market","title":"Sub-market 相關購買關聯","description":"取得買過指定子分類的消費者，還買了哪些其他子分類 Top 5；此端點使用目前預設資料區間快取，不支援自訂日期即時計算。","method":"GET","path":"/api/public/sub-market/related-purchases","queryParams":[{"name":"category","type":"string","required":false,"description":"主分類名稱。未提供或無效時會使用系統預設主分類。","example":"美妝保養"},{"name":"sub","type":"string","required":false,"description":"子分類名稱。未提供或無效時會使用系統預設子分類。","example":"精華液"}],"examplePath":"/api/public/sub-market/related-purchases?category=3C周邊&sub=平板","usagePoints":60,"fixedUsage":true,"mcpToolName":"sub_market.related_purchases","mcpDescription":"取得指定子分類的相關購買關聯 Top 5；使用目前預設資料區間快取。","responseSummary":[{"name":"code","type":"number","description":"固定為 200。"},{"name":"data.type","type":"string","description":"固定為 sub-market-related-purchases。"},{"name":"data.category","type":"string","description":"實際使用的主分類名稱。"},{"name":"data.subCategory","type":"string","description":"實際使用的子分類名稱。"},{"name":"data.start","type":"string","description":"回應資料涵蓋的起始日期。"},{"name":"data.end","type":"string","description":"回應資料涵蓋的結束日期。"},{"name":"data.items[].category","type":"string","description":"關聯購買的主分類名稱。"},{"name":"data.items[].subCategory","type":"string","description":"關聯購買的子分類名稱。"},{"name":"data.items[].memberCount","type":"number","description":"符合關聯條件的消費者人數。"},{"name":"data.items[].percent","type":"number","description":"Top 清單內的佔比百分比數值。"}]}]}