v0.2.0-beta

OpenAPI 3.1.0

即時商家列表搜尋任務

Felo API Support

MIT

伺服器

https://openapi.felo.ai

用戶端程式庫

Shell Curl

DataForSEO

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO 操作

post/v1/beta/dataforseo/business_data/business_listings/search/live

即時商家列表搜尋任務

依 categories、description、title 與 location_coordinate（緯度、經度與半徑三元組）搜尋 DataForSEO 自有的本地商家列表索引。回傳 total_count、count、offset、offset_token 與 items，並使用該權杖分頁。採用 DataForSEO 的信封結構：資料位於 tasks[0].result，結果狀態位於 tasks[0].status_code——被拒絕的請求仍會回傳 HTTP 200。此端點讀取索引並立即回傳結果；此處的其他端點都會將對來源的即時擷取排入佇列。先從這裡開始，只在確實需要時再深入。

計費參考

計量方式：依回報的回應成本計量。
參考請求估算：0.2428 美元。
參考客戶倍率：1.0。不得對已結算的客戶金額再次套用。

僅供參考的中繼資料，並非帳戶報價、保證價格或消費上限。資源額度並非 Felo 額度。最終費用依 Felo 計費記錄為準。

請求本文

application/json

類型: array (object | null)[]
- categories
  類型: array string[] | null
  
  商家類別
  選填欄位
  指定的類別用於搜尋商家列表；
  若未使用此欄位，我們將傳回指定位置中發現的商家列表；
  最多可指定 10 個類別
- description
  類型: string | null
  
  SERP 中元素的描述
  選填欄位
  收集結果所針對的商家實體描述；
  最多可包含 200 個字元
- filters
  類型: array (object | null)[] | null
  
  結果篩選參數陣列
  選填欄位
  可同時新增多個篩選條件（最多 8 個）
  應在條件之間設定邏輯運算子 and、or
  支援下列運算子：
  regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match
  可將 % 運算子與 like、not_like 搭配使用，比對任意長度（含零個字元）的字串
  範例：
  ["rating.value",">",3]
  可個別向 https://api.dataforseo.com/v3/business_data/business_listings/available_filters 發出請求，取得可用的篩選條件清單
  完整的可用篩選條件清單請見此處。
  
  空物件
- is_claimed
  類型: boolean | null
  
  表示商家是否已由其所有者在 Google Maps 上驗證
  選填欄位
- limit
  類型: integer | null
  
  傳回的商家數量上限
  選填欄位
  預設值：100
  最大值：1000
- location_coordinate
  類型: string | null
  
  位置的 GPS 座標
  選填欄位
  location_coordinate 參數應以 "latitude,longitude,radius" 格式指定
  "latitude" 與 "longitude" 的最大小數位數為 7
  "radius" 的值以公里（km）為單位
  "radius" 的最小值：1
  "radius" 的最大值：100000
  範例：
  53.476225,-2.243572,200
  如需進一步瞭解如何在此 API 中設定位置參數，請參閱我們的說明中心
- offset
  類型: integer | null
  
  傳回的商家在結果陣列中的位移量
  選填欄位
  預設值：0
  若指定 10，結果陣列中的前 10 個實體將被略過，並傳回後續實體的資料
  注意：建議僅在擷取最多 10,000 筆結果時使用此參數
  如需擷取超過 10,000 筆結果，請改用 offset_token
- offset_token
  類型: string | null
  
  用於後續請求的權杖
  選填欄位
  在每次請求回應的同名欄位中提供；
  使用此參數可在單次請求嘗試取得超過 100,000 筆結果時避免逾時；
  透過指定回應陣列中的唯一 offset_token 值，你將取得初始任務的後續結果；
  offset_token 值對每個後續任務都是唯一的
  注意：如果請求中指定了 offset_token，所有其他參數都應與先前的請求保持一致
  如需進一步瞭解此參數，請參閱我們的說明中心
- order_by
  類型: array string[] | null
  
  結果排序規則
  選填欄位
  可使用與 filters 陣列相同的值對結果排序
  可用的排序類型：
  asc - 結果依升冪排列
  desc - 結果依降冪排列
  應使用逗號設定排序參數
  範例：
  ["rating.value,desc"]請注意，單一請求中最多可設定三條排序規則
  應使用逗號分隔多條排序規則
  範例：
  ["rating.value,desc","rating.votes_count,desc"]
- tag
  類型: string | null
  
  使用者自訂任務識別碼
  選填欄位
  字元數上限為 255
  可使用此參數識別任務，並將其與結果對應
  可在回應的 data 物件中找到指定的 tag 值
- title
  類型: string | null
  
  SERP 中元素的標題
  選填欄位
  收集結果所針對的商家實體名稱；
  最多可包含 200 個字元

回應

200
類型: object | null · Response36Afe1097B20_BusinessDataBusinessListingsSearchLiveResponseInfo
cost
類型: number | null 格式: double

任務總費用，美元

status_code
類型: integer | null

一般狀態碼完整回應碼清單請見此處

status_message
類型: string | null

一般資訊訊息完整的一般資訊訊息清單請見此處

tasks
類型: array (object | null)[] | null

任務陣列

類型: object | null · Response36Afe1097B20_BusinessDataBusinessListingsSearchLiveTaskInfo
cost
類型: number | null 格式: double

任務總費用，美元

data
類型: object | null

包含你在 POST 請求中指定的相同參數

propertyName
類型: object | null
id
類型: string | null

任務識別碼我們系統中 UUID 格式的唯一任務識別碼

path
類型: array (string | null)[] | null

URL 路徑

result
類型: array (object | null)[] | null

結果陣列

count
類型: integer | null 格式: int64

項目類型
items 陣列中的項目數

items
類型: array (object | null)[] | null

遇到的項目類型
items 陣列中出現的搜尋引擎結果類型；
可能的項目類型：business_listing

additional_categories
類型: array (string | null)[] | null

其他商家類別
更詳細描述商家實體所提供服務的其他 Google My Business 類別

address
類型: string | null

商家實體的地址

address_info
類型: object | null · Response36Afe1097B20_AddressInfo

包含商家實體地址組成部分的物件

address
類型: string | null

本地商家的街道地址

borough
類型: string | null

本地商家所屬的行政單位或區域

city
類型: string | null

本地商家所在城市的名稱

country_code
類型: string | null

本地商家的 ISO 國家代碼

region
類型: string | null

本地商家所屬的 DMA 區域

zip
類型: string | null

本地商家的郵遞區號

attributes
類型: object | null · Response36Afe1097B20_BusinessDataAttributesInfo

以使用者評論勾選項形式呈現的服務詳情；
以勾選項形式展示、依據使用者意見回饋與商家 category 的商家實體服務詳情

available_attributes
類型: object | null

可用屬性
表示商家實體可提供的屬性

propertyName
類型: array (string | null)[] | null
unavailable_attributes
類型: object | null

不可用屬性
表示商家實體無法提供的屬性

propertyName
類型: array (string | null)[] | null
category
類型: string | null

商家類別
最能描述商家實體所提供服務的 Google My Business 通用類別

category_ids
類型: array (string | null)[] | null

全域類別 ID
不隨所選國家/地區變更的通用類別 ID

check_url
類型: string | null

搜尋引擎結果的直接 URL
可用來確認我們提供了準確的結果

cid
類型: string | null

Google 定義的用戶端 ID
本地商家的唯一 ID
如需進一步瞭解此識別碼，請參閱這篇說明中心文章

contact_info
類型: array (object | null)[] | null

商家的可用聯絡方式
用於與商家聯絡的聯絡方式清單

source
類型: string | null

資料來源

type
類型: string | null

元素類型

value
類型: string | null

評分的值

description
類型: string | null

SERP 中元素的說明
收集結果所針對之商家實體的說明

domain
類型: string | null

商家實體的網域

feature_id
類型: string | null

SERP 中元素的唯一識別碼
如需進一步瞭解該識別碼，請參閱這篇說明中心文章

first_seen
類型: string | null

我們的檢索器首次發現該商家資訊元素的日期與時間
採用 UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”
範例：
2023-03-11 10:04:11 +00:00

hotel_rating
類型: integer | null

飯店星級評分
星級評分範圍為 1-5 星，瞭解更多
如果沒有飯店星級評分資訊，該值將為 null

is_claimed
類型: boolean | null

顯示該實體是否已由其所有者在 Google Maps 上驗證

last_updated_time
類型: string | null

資料最後更新的日期與時間
採用 UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”
範例：
2023-01-26 09:03:15 +00:00

latitude
類型: number | null

當地商家在 Google 地圖中的緯度座標
範例：
"latitude": 51.584091

local_business_links
類型: array (object | null)[] | null

與商家可用的互動
可直接從搜尋結果與商家互動的選項清單

type
類型: string | null

元素類型

logo
類型: string | null

Google 我的商家檔案中展示的標誌 URL

longitude
類型: number | null

當地商家在 Google 地圖中的經度座標
範例：
"longitude": -0.31365919999999997

main_image
類型: string | null

Google My Business 檔案中顯示的主圖片 URL

original_title
類型: string | null

項目的原始標題
未經 Google 翻譯的原始標題

people_also_search
類型: array (object | null)[] | null

相關商家實體

cid
類型: string | null

Google 定義的用戶端 ID
本地商家的唯一 ID
如需進一步瞭解此識別碼，請參閱這篇說明中心文章

feature_id
類型: string | null

SERP 中元素的唯一識別碼
如需進一步瞭解該識別碼，請參閱這篇說明中心文章

rating
類型: object | null · Response36Afe1097B20_RatingInfo

元素的評分
依據評論並顯示於 SERP 的熱度評分

rating_max
類型: integer | null

rating_type 的最大值

rating_type
類型: string | null

評分類型此處可以找到下列元素：Max5、Percents、CustomMax

value
類型: number | null 格式: double

評分的值

votes_count
類型: integer | null 格式: int64

回饋數量

title
類型: string | null

SERP 中元素的標題
收集結果所針對的商家實體名稱

phone
類型: string | null

商家實體的電話號碼

place_id
類型: string | null

唯一地點識別碼
元素中所示當地商家的地點 ID
如需進一步瞭解此識別碼，請參閱這篇說明中心文章

place_topics
類型: object | null

顧客評論中提及的關鍵字
包含與商家實體顧客評論中提及的產品/服務相關的最熱門關鍵字，以及提及每個關鍵字的評論數
範例："place_topics": { "egg roll": 48, "birthday": 33 }

propertyName
類型: integer | null 格式: int64

Signed 64-bit integers (long type).

popular_times
類型: object | null · Response36Afe1097B20_PopularTimes

熱門時段
與商家實體忙碌時段相關的資訊

popular_times_by_days
類型: object | null

熱門時段
本地商家每週各天忙碌時段的資訊

propertyName
類型: array (object | null)[] | null

週日的營業時間

popular_index
類型: integer | null

人氣指數依時間衡量的相對人氣指數，範圍為 0 到 100；值越高表示一天中越繁忙的時段

time
類型: object | null · Response36Afe1097B20_TimeInfo

24 小時制的小時

hour
類型: integer | null

24 小時制的小時

minute
類型: integer | null

分鐘

price_level
類型: string | null

場所價格等級
可採用下列值：inexpensive、moderate、expensive、very_expensive
如果沒有價格等級資訊，該值將為 null

rating
類型: object | null · Response36Afe1097B20_RatingInfo

元素的評分
依據評論並顯示於 SERP 的熱度評分

rating_max
類型: number | null 格式: double

rating_type 的最大值

rating_type
類型: string | null

評分類型此處可以找到下列元素：Max5、Percents、CustomMax

value
類型: number | null 格式: double

評分的值

votes_count
類型: integer | null 格式: int64

回饋數量

rating_distribution
類型: object | null

商家實體的評分分佈
該物件顯示使用者評論的 1 星到 5 星評分數

propertyName
類型: integer | null 格式: Int64
services
類型: array (object | null)[] | null
category
類型: string | null

商家類別
最能描述商家實體所提供服務的 Google My Business 通用類別

price
類型: object | null · Response36Afe1097B20_PriceInfo
currency
類型: string | null

所列價格的貨幣套用於該價格的貨幣 ISO 代碼

current
類型: number | null 格式: double

目前價格表示結果中所展示產品或服務的目前價格

displayed_price
類型: string | null

結果中的價格字串結果中提供的原始價格字串

is_price_range
類型: boolean | null

價格以區間形式提供表示價格是否以區間形式提供

max_value
類型: number | null 格式: double

最高價格結果中所示產品或服務的最高價格

regular
類型: number | null 格式: double

一般價格表示未套用任何折扣的產品或服務一般價格

snippet
類型: string | null

商家實體的額外資訊

title
類型: string | null

SERP 中元素的標題
收集結果所針對的商家實體名稱

snippet
類型: string | null

商家實體的額外資訊

title
類型: string | null

SERP 中元素的標題
收集結果所針對的商家實體名稱

total_photos
類型: integer | null 格式: int64

Google My Business 檔案中顯示的圖片總數

type
類型: string | null

元素類型

url
類型: string | null

商家實體的絕對 URL

work_time
類型: object | null · Response36Afe1097B20_BusinessWorkHoursInfo

營業時間詳細資料
與商家實體營業時間相關的資訊

work_hours
類型: object | null · Response36Afe1097B20_WorkHours

營業時間
當地商家的營業時間資訊

current_status
類型: string | null

商家的目前狀態
指出商家是否營業

timetable
類型: object | null

營業時間表

propertyName
類型: array (object | null)[] | null

週日的營業時間

close
類型: object | null · Response36Afe1097B20_TimeInfo

結束時間

hour
類型: integer | null

24 小時制的小時

minute
類型: integer | null

分鐘

open
類型: object | null · Response36Afe1097B20_TimeInfo

開始時間

hour
類型: integer | null

24 小時制的小時

minute
類型: integer | null

分鐘

offset
類型: integer | null 格式: int64

Signed 64-bit integers (long type).

offset_token
類型: string | null
total_count
類型: integer | null 格式: int64

我們資料庫中與你的請求相關的結果總數

result_count
類型: integer | null 格式: int64

result 陣列中的元素數

status_code
類型: integer | null

任務的狀態碼由 DataForSEO 產生，範圍如下：10000-60000 完整回應碼清單請見此處

status_message
類型: string | null

任務的資訊訊息完整的一般資訊訊息清單請見此處

time
類型: string | null

執行時間，秒

tasks_count
類型: integer | null 格式: int64

tasks 陣列中的任務數

tasks_error
類型: integer | null 格式: int64

tasks 陣列中傳回錯誤的任務數

time
類型: string | null

總執行時間，秒

version
類型: string | null

API 的目前版本
application/json
400

無法處理該要求。請檢查請求參數。
401

需要有效的 Felo API 金鑰。
402

由於未符合計費要求，要求無法繼續。
403

該帳戶無權執行此操作。
429

已達到要求或支出上限。
502

服務無法完成該要求。
503

API 或計費服務暫時無法使用。
504

服務在處理要求時逾時。
default

錯誤回應；上游透傳回應可能採用供應商格式

application/json

post/v1/beta/dataforseo/business_data/business_listings/search/live

curl https://openapi.felo.ai/v1/beta/dataforseo/business_data/business_listings/search/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "categories": [
      "pizza_restaurant"
    ],
    "description": "pizza",
    "title": "pizza",
    "is_claimed": true,
    "location_coordinate": "53.476225,-2.243572,10",
    "order_by": [
      "rating.value,desc"
    ],
    "filters": [
      [
        "rating.value",
        ">",
        3
      ]
    ],
    "limit": 3
  }
]'

顯示 Schema

{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": [
        {
          "total_count": null,
          "count": null,
          "offset": null,
          "offset_token": null,
          "items": [
            {
              "type": null,
              "title": null,
              "original_title": null,
              "description": null,
              "category": null,
              "category_ids": [
                "[Max Depth Exceeded]"
              ],
              "additional_categories": [
                "[Max Depth Exceeded]"
              ],
              "cid": null,
              "feature_id": null,
              "address": null,
              "address_info": "[Max Depth Exceeded]",
              "place_id": null,
              "phone": null,
              "url": null,
              "domain": null,
              "logo": null,
              "main_image": null,
              "total_photos": null,
              "snippet": null,
              "latitude": null,
              "longitude": null,
              "is_claimed": null,
              "attributes": "[Max Depth Exceeded]",
              "place_topics": null,
              "rating": {
                "0": "[",
                "1": "M",
                "2": "a",
                "3": "x",
                "4": " ",
                "5": "D",
                "6": "e",
                "7": "p",
                "8": "t",
                "9": "h",
                "10": " ",
                "11": "E",
                "12": "x",
                "13": "c",
                "14": "e",
                "15": "e",
                "16": "d",
                "17": "e",
                "18": "d",
                "19": "]",
                "rating_type": "[Max Depth Exceeded]",
                "value": "[Max Depth Exceeded]",
                "votes_count": "[Max Depth Exceeded]",
                "rating_max": "[Max Depth Exceeded]"
              },
              "hotel_rating": null,
              "price_level": null,
              "rating_distribution": null,
              "people_also_search": [
                "[Max Depth Exceeded]"
              ],
              "work_time": "[Max Depth Exceeded]",
              "popular_times": "[Max Depth Exceeded]",
              "local_business_links": [
                "[Max Depth Exceeded]"
              ],
              "contact_info": [
                "[Max Depth Exceeded]"
              ],
              "check_url": null,
              "last_updated_time": null,
              "first_seen": null,
              "services": [
                "[Max Depth Exceeded]"
              ]
            }
          ]
        }
      ]
    }
  ]
}

操作成功

需要協助嗎？

API、帳務或帳號問題，請聯絡支援。
在 Discord 上與 Felo 開發者交流。
查看我們的更新日誌。
需要大量授權或採購協助？聯絡業務。
正在用 LLM 開發？閱讀 llms.txt。

即時商家列表搜尋任務

身分驗證Required

DataForSEO

即時商家列表搜尋任務

計費參考

需要協助嗎？