API Documentation v2

Name

deal/active

Description

Retrieves a list of active deals, optionally filtered by active market, local (1 for all local deals or 0 for all non-local deals for a given market) with a limit of 50 and page (defaults to 1).

URL

https://www.spreebird.com/api/v2/deal/active.xml

Supported Request Method

GET

Supported Return Formats

JSON (default), XML

Parameters

Required

api_key

Optional

market, local, page

Example Responses

JSON (default)

{     "response":{         "transaction_id":"da633151747a7281ee7f8b4fda272c77",         "requested_at":"2010-02-23 21:03:29",         "method":"deal\/active",         "deals":[             {                 "id":"cfcd208495d565ef66e7dff9f98764da",                 "market":"tampa",                 "category":"Restaurants",                 "title":"$12 for $25 worth of Food and Drinks!",                 "details":[                     "Limit 1 voucher per table.",                     "Cannot be combined with other offers.",                     "Tax and Gratuity not included.",                     "Voucher has no cash value."                 ],                 "permalink":"http:\/\/www.crowdsavings.com\/api\/v2",                 "merchant":"The Restaurant",                 "profile":"Lorem ipsum dolor sit amet, consectetur adipiscing elit...",                 "website":"http:\/\/www.crowdsavings.com",                 "logo":"http:\/\/www.crowdsavings.com\/images\/logo.jpg",                 "images":[                     "http:\/\/www.crowdsavings.com\/images\/image1.jpg",                     "http:\/\/www.crowdsavings.com\/images\/image2.jpg",                     "http:\/\/www.crowdsavings.com\/images\/image3.jpg",                     "http:\/\/www.crowdsavings.com\/images\/image4.jpg",                     "http:\/\/www.crowdsavings.com\/images\/image5.jpg"                 ],                 "currency":"USD",                 "discount_price":"12.00",                 "retail_price":"25.00",                 "discount_amount":"13.00",                 "discount_percent":"52.00",                 "started_at":"Mon, 12 Jul 2010 04:00:00 -0400",                 "ends_at":"Tue, 13 Jul 2010 03:59:59 -0400",                 "expires_at":"Thu, 13 Jan 2011 03:59:59 -0400",                 "featured":1,                 "national":0,                 "shipped":0,                 "sold":100,                 "sold_out":0,                 "max_per_customer":1,                 "max_as_gifts":2,                 "locations":[                     {                         "name":"The Restaurant South Tampa",                         "address1":"1313 Mocking Bird Lane",                         "address2":"",                         "city":"Tampa",                         "state":"FL",                         "zip":"33666",                         "phone":"8135551212",                         "latitude":"27.968555",                         "longitude":"-82.463336"                     }                 ]             }         ]     } }

XML

<?xml version="1.0" encoding="UTF-8"?> <response>     <transaction_id>da633151747a7281ee7f8b4fda272c77</transaction_id>     <requested_at>2010-02-23 21:03:29</requested_at>     <method>deal/active</method>     <deals>         <deal>             <id>cfcd208495d565ef66e7dff9f98764da</id>             <market>tampa</market>             <category>Restaurants</category>             <title>$12 for $25 worth of Food and Drinks!</title>             <details>                 <detail>Limit 1 voucher per table.</detail>                 <detail>Cannot be combined with other offers.</detail>                 <detail>Tax and Gratuity not included.</detail>                 <detail>Voucher has no cash value.</detail>             </details>             <permalink>http://www.crowdsavings.com/api/v2</permalink>             <merchant>The Restaurant</merchant>             <profile>Lorem ipsum dolor sit amet, consectetur adipiscing elit...</profile>             <website>http://www.crowdsavings.com</website>             <logo>http://www.crowdsavings.com/images/logo.jpg</logo>             <images>                 <image>http://www.crowdsavings.com/images/image1.jpg</image>                 <image>http://www.crowdsavings.com/images/image2.jpg</image>                 <image>http://www.crowdsavings.com/images/image3.jpg</image>                 <image>http://www.crowdsavings.com/images/image4.jpg</image>                 <image>http://www.crowdsavings.com/images/image5.jpg</image>             </images>             <currency>USD</currency>             <discount_price>12.00</discount_price>             <retail_price>25.00</retail_price>             <discount_amount>13.00</discount_amount>             <discount_percent>52.00</discount_percent>             <started_at>Mon, 12 Jul 2010 04:00:00 -0400</started_at>             <ends_at>Tue, 13 Jul 2010 03:59:59 -0400</ends_at>             <expires_at>Thu, 13 Jan 2011 03:59:59 -0400</expires_at>             <featured>1</featured>             <national>0</national>             <shipped>0</shipped>             <sold>100</sold>             <sold_out>0</sold_out>             <max_per_customer>1</max_per_customer>             <max_as_gifts>2</max_as_gifts>             <locations>                 <location>                     <name>The Restaurant South Tampa</name>                     <address1>1313 Mocking Bird Lane</address1>                     <address2></address2>                     <city>Tampa</city>                     <state>FL</state>                     <zip>33666</zip>                     <phone>8135551212</phone>                     <latitude>27.968555</latitude>                     <longitude>-82.463336</longitude>                 </location>             </locations>         </deal>     </deals> </response>