API文档 >>  搜索团购

  • API名称: 搜索团购 Deal/find_deals
  • 描述:按照地理位置、分类、关键词等多种条件搜索团购信息,并以分页形式返回
  • 数据格式:JSON/XML
  • 方法:HTTP GET
  • 等级:普通
  • 是否需要用户授权:
  • 请求URL:http://api.dianping.com/v1/deal/find_deals

请求参数

  • 必选参数

    名称 类型 说明
    appkey string App Key,应用的唯一标识
    sign string 请求签名,生成方式见《API请求签名生成文档》
    city string 包含团购信息的城市名称,可选范围见相关API返回结果
  • 可选参数

    名称 类型 说明
    destination_city string 指定目的地城市名称,适用于“酒店”、“旅游”等分类,可选范围见相关API返回结果
    latitude float 纬度坐标,须与经度坐标同时传入
    longitude float 经度坐标,须与纬度坐标同时传入
    radius int 搜索半径,单位为米,最小值1,最大值5000,如不传入默认为1000
    region string 包含团购信息的城市区域名,可选范围见相关API返回结果(不含返回结果中包括的城市名称信息)
    category string 包含团购信息的分类名,支持多个category合并查询,多个category用逗号分割。可选范围见相关API返回结果
    is_local int 根据是否是本地单来筛选返回的团购,1:是,0:不是
    keyword string 关键词,搜索范围包括商户名、商品名、地址等
    sort int 结果排序,1:默认,2:价格低优先,3:价格高优先,4:购买人数多优先,5:最新发布优先,6:即将结束优先,7:离经纬度坐标距离近优先
    limit int 每页返回的团单结果条目数上限,最小值1,最大值40,如不传入默认为20
    page int 页码,如不传入默认为1,即第一页
    format string 返回数据格式,可选值为json或xml,如不传入,默认值为json

返回结果

  • 状态字段

    名称 类型 说明
    status string 本次API访问状态,如果成功返回"OK",并返回结果字段,如果失败返回"ERROR",并返回错误说明
    count int 本次API访问所获取的单页团购数量
    total_count int 所有页面团购总数
  • 结果字段

    名称 类型 说明
    deal_id string 团购单ID
    title string 团购标题
    description string 团购描述
    city string 城市名称,city为"全国"表示全国单,其他为本地单,城市范围见相关API返回结果
    list_price float 团购包含商品原价值
    current_price float 团购价格
    regions list 团购适用商户所在行政区
    categories list 团购所属分类
    purchase_count int 团购当前已购买数
    publish_date string 团购发布上线日期
    purchase_deadline string 团购单的截止购买日期
    distance int 团购单所适用商户中距离参数坐标点最近的一家与坐标点的距离,单位为米;如不传入经纬度坐标,结果为-1;如团购单无关联商户,结果为MAXINT
    image_url string 团购图片链接,最大图片尺寸450×280
    s_image_url string 小尺寸团购图片链接,最大图片尺寸160×100
    deal_url string 团购Web页面链接,适用于网页应用
    deal_h5_url string 团购HTML5页面链接,适用于移动应用和联网车载应用
    commission_ratio float 当前团单的佣金比例
    businesses list 团购所适用的商户列表
    businesses.name string 商户名
    businesses.id int 商户ID
    businesses.url string 商户页链接

注意事项

  • 传入经纬度坐标参数(latitude/longitude),所获取的团购单列表才能限定在特定区域范围内,或按照距离排序

API测试工具

示例请求

http://api.dianping.com/v1/deal/find_deals?city=上海&region=黄浦区&category=电影&limit=1&page=1&appkey=[appkey]&sign=[signature]

示例结果

{
  "status": "OK",
  "total_count": 11,
  "count": 1,
  "deals": [
    {
      "deal_id": "1-5160525",
      "title": "永华电影城单人电影票套餐",
      "description": "上影永华●海上国际影城连锁影院 仅售36元 价值130元单人电影票套餐 现代化星级影城 高端观影设备 感受震撼视觉享受",
      "city": "上海",
      "list_price": 130,
      "current_price": 36,
      "regions": [
        "徐汇区",
        "浦东新区",
        "黄浦区",
        "普陀区",
        "闵行区",
        "奉贤区"
      ],
      "categories": [
        "电影"
      ],
      "purchase_count": 5080,
      "purchase_deadline": "2014-02-28",
      "publish_date": "2013-12-04",
      "distance": 0,
      "image_url": "http://t3.dpfile.com/pc/mc/37a875004de0eb581709c4c9ffb20d06(450x1024)/thumb.jpg",
      "s_image_url": "http://t1.dpfile.com/pc/mc/37a875004de0eb581709c4c9ffb20d06(450x1024)/thumb_1.jpg",
      "deal_url": "http://dpurl.cn/p/WH0EczH4Yc",
      "deal_h5_url": "http://dpurl.cn/p/iq0zc2H5aS",
      "commission_ratio": 0.03,
      "businesses": [
        {
          "name": "超极电影世界",
          "id": 1795150,
          "city": "上海",
          "latitude": 31.19375,
          "longitude": 121.43953,
          "url": "http://dpurl.cn/p/m2jj4EZEcY",
          "h5_url": "http://dpurl.cn/p/OAfT1SwG+v"
        },
        {
          "name": "新衡山电影院",
          "id": 1796983,
          "city": "上海",
          "latitude": 31.197136,
          "longitude": 121.440895,
          "url": "http://dpurl.cn/p/-UROzi25Mg",
          "h5_url": "http://dpurl.cn/p/KCCs587OZ1"
        },
        {
          "name": "永华电影城",
          "id": 1881676,
          "city": "上海",
          "latitude": 31.194883,
          "longitude": 121.43773,
          "url": "http://dpurl.cn/p/4Xjo0r-xUM",
          "h5_url": "http://dpurl.cn/p/1AhW-fRemq"
        },
        {
          "name": "上影华威电影城",
          "id": 1881682,
          "city": "上海",
          "latitude": 31.235233,
          "longitude": 121.473785,
          "url": "http://dpurl.cn/p/dxswF4kgTz",
          "h5_url": "http://dpurl.cn/p/0UawX9SWzK"
        },
        {
          "name": "海上国际影城(南桥百联店)",
          "id": 4287352,
          "city": "上海",
          "latitude": 30.91587,
          "longitude": 121.48397,
          "url": "http://dpurl.cn/p/YzmYQ3Zh6p",
          "h5_url": "http://dpurl.cn/p/qlqgLVZQVF"
        },
        {
          "name": "海上国际影城(莘庄龙之梦店)",
          "id": 5164689,
          "city": "上海",
          "latitude": 31.108149,
          "longitude": 121.3777,
          "url": "http://dpurl.cn/p/pJ36mK4wp9",
          "h5_url": "http://dpurl.cn/p/PL8ct-zvn5"
        },
        {
          "name": "海上国际影城(喜玛拉雅店)",
          "id": 5479777,
          "city": "上海",
          "latitude": 31.21016,
          "longitude": 121.56175,
          "url": "http://dpurl.cn/p/6ubvOmQNpW",
          "h5_url": "http://dpurl.cn/p/XRbQbO+Jzy"
        },
        {
          "name": "海上国际影城(月星环球港店)",
          "id": 10017328,
          "city": "上海",
          "latitude": 31.23138,
          "longitude": 121.41108,
          "url": "http://dpurl.cn/p/xd7HJmfsVI",
          "h5_url": "http://dpurl.cn/p/NVdbB0CPVJ"
        }
      ]
    }
  ]
}