API文档 >>  搜索优惠券

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

请求参数

  • 必选参数

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

    名称 类型 说明
    latitude float 纬度坐标,须与经度坐标同时传入
    longitude float 经度坐标,须与纬度坐标同时传入
    radius int 搜索半径,单位为米,最小值1,最大值5000,如不传入,默认值为1000
    region string 包含优惠券信息的城市区域名,可选范围见相关API返回结果(不含返回结果中包括的城市名称信息)
    category string 包含优惠券信息的分类名,可选范围见相关API返回结果
    keyword string 关键词,搜索范围包括商户名、优惠券名等
    sort int 结果排序,1:最新发布优先,2:热门优惠优先,3:最优优惠优先,4:即将结束优先,5:离经纬度坐标距离近优先,如不传入,默认值为1
    limit int 每页返回的团单结果条目数上限,最小值1,最大值40,如不传入默认为20
    page int 页码,如不传入默认为1,即第一页
    format string 返回数据格式,可选值为json或xml,如不传入,默认值为json

返回结果

  • 状态字段

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

    名称 类型 说明
    coupon_id int 优惠券ID
    title string 优惠券标题
    description string 优惠券描述
    regions list 优惠券适用商户所在行政区
    categories list 优惠券所属分类
    download_count int 优惠券当前已下载量
    publish_date string 优惠券发布上线日期
    expiration_date string 优惠券的截止使用日期
    distance int 优惠券所适用商户中距离参数坐标点最近的一家与坐标点的距离,单位为米;如不传入经纬度坐标,结果为-1;如优惠券无关联商户,结果为MAXINT
    logo_img_url string 优惠券的图标,尺寸120*90
    coupon_url string 优惠券Web页面链接,适用于网页应用
    coupon_h5_url string 优惠券HTML5页面链接,适用于移动应用和联网车载应用
    businesses list 优惠券所适用的商户列表
    businesses.name string 商户名
    businesses.id int 商户ID
    businesses.url string 商户页Web页面链接,适用于网页应用
    businesses.h5_url string 商户HTML5页面链接,适用于移动应用和联网车载应用

注意事项

  • 传入经纬度坐标参数(latitude/longitude),所获取的优惠券列表才能按照距离排序

API测试工具

示例请求

http://api.dianping.com/v1/deal/find_coupons?city=上海&category=美食&limit=2&page=1&sort=1&appkey=[appkey]&sign=[signature]

示例结果

{ "status": "OK", "total_count": 1429, "count": 2, "coupons": [ { "coupon_id": 198017, "title": "糖果美甲Nail Salon", "description": "OPI特价美甲38元", "regions": [ "普陀区" ], "categories": [ "美甲" ], "download_count": 0, "publish_date": "2013-08-27", "expiration_date": "2013-09-26", "distance": -1, "logo_img_url": "http://p.dpfile.com/Promo/2013-07-22/194879_bl.jpg", "coupon_url": "http://dpurl.cn/p/Qbn6dtek+f", "coupon_h5_url": "http://dpurl.cn/p/o7CB9aCFIz", "businesses": [ { "name": "糖果美甲Nail Salon Candy", "id": 13670632, "url": "http://dpurl.cn/p/8QWM4PFrYC", "h5_url": "http://dpurl.cn/p/VI7ODAWGZ2" } ] }, { "coupon_id": 198076, "title": "鼎琅臻品宾馆", "description": "新店酬宾 休息房80元4小时", "regions": [ "杨浦区" ], "categories": [ "精品酒店" ], "download_count": 0, "publish_date": "2013-08-27", "expiration_date": "2013-12-24", "distance": -1, "logo_img_url": "http://p.dpfile.com/Promo/2013-06-24/192163_bl.jpg", "coupon_url": "http://dpurl.cn/p/lGmqakgKby", "coupon_h5_url": "http://dpurl.cn/p/B0gLNtpuPk", "businesses": [ { "name": "鼎琅臻品宾馆", "id": 11551962, "url": "http://dpurl.cn/p/qKmsdPDd86", "h5_url": "http://dpurl.cn/p/otM0WcDXF1" } ] }}