if you need assistance with integrating our API, chat with one of us and we will get you running in no time.
Online API help chat
There is no daily limit once you obtain an API Key
We try to make it easy for you to integrate Sidebuy API to your platform. You might as well just copy and paste the code from these sample codes to your project.
API Endpoint
http://v1.sidebuy.com/api/get/{api_key}/?{parameters}
Example: http://v1.sidebuy.com/api/get/abc62ee1fd09c296fb9f45702063a374/?city=vancouver&search=spa<s>pizza&format=xml
*By default sidebuy API uses RESTful GET requests. However POST requests are also supported and work in the same way.
*The API Key provided in the samples only works 500 times for testing purposes only. You need to get your own API key for unlimited access to this API.
Request parameters
These parameters can be passed along with the API endpoint. for a basic request either city or loc + range + mkm must be passed.View a list of city codes (United States, Canada, Australia)
radius to retrieve deals
separate by <s> for multiple keywords.
0 - other
1 - activities
2 - events
3 - food
4 - health & beauty
5 - pets
6 - services
7 - shopping
8 - sports
9 - travel
separate by <s> for multiple categories
available fields: title, description, expiryepoch, link, image, price, original_price, discount, saving, city, fineprint, highlights, merchant
separate by <s> for multiple fields
(type: string) (default: 0-100)
(type: string) (default: expiryepoch)
field name separated by | -1 = DESC, 1 = ASC
e.g. 4 days 3 hours 20 minutes
Note: json must be used as the format.
Response parameters
Sidebuy API response is in JSON format. Therefore the response is a valid JSON document and some characters need to be translated back to HTML. For more information view examples.
Menu
- Hawaiian
- Pepperoni
- Mushroom Lovers
- Italian Sausage
Deal currency if other than $.
If a deal is not in US or Canada, deal market is provided.
"name":"The Best Pizerria",
"address":"23220 West Hastings",
"city":"Vancouver",
"zip":"V6A 3ST",
"state":"BC",
"country":"Canada",
"tel":"604 001 9339",
"website":"www.thebestpizzeria.ca"
}
*The API Key provided in the samples only works 500 times for testing purposes only. You need to get your own API key for unlimited access to this API.
Basic usage: Retrieve all deals in New York.
format: Retrieve all deals in New York in XML (for JSON, change format to json)
Search: Retrieve all deals in New York with keyword "pizza" and "spa".
Retrieve all deals within 50 miles of New York using Coordinates (40.7143528,-74.0059731). For km, change miles to km.
Retrieve all deals within 50 miles of New York using Coordinates and filter by category (food, shopping)
Retrieve all deals in New York, sort by expiry.
Retrieve all deals in New York, only return first 5 deals (useful for record set paging. to view the next batch of 5 deals change to 5-10 and so on)
Retrieve all deals in New York, only return second 5 deals (see previous example)
Retrieve all travel deals.
Retrieve all online deals.
Retrieve deal titles and prices from New York.
Retrieve all deals within 100 km of New York that are provided by Groupon display in XML format.
view a live response example in JSONview a live response example in XML
Sample JSON response
[ { "addedepoch": "1329863852","category": "0",
"city": "new-york",
"description": "a long description",
"hash": "127962256f2e5ee6e3edc99739ac8cc4",
"highlights": "",
"id": "431343",
"image": "http://sidebuy.s3.amazonaws.com/13298638518598.jpg",
"link": "http://sidebuy.com/deals/affiliate/abc62ee1fd09c296fb9f45702063a374/4f1e0b1fd692283304000075",
"loc": {
"latitude": 40.7737536,
"longitude": -73.9660434
},
"merchant": {
"name": "Underdog Fitness",
"address": "East 74th St. and 5th Ave. New York, NY 10021",
"city": "",
"zip": "",
"state": "",
"country": "",
"tel": "",
"website": "http://www.underdogfitness.com"
},
"online": "false",
"original_price": "1306.00",
"price": 499,
"provider": "pinchit",
"saving": "807.00",
"title": "63% Off personalized workout program",
"travel": "false"
},
{
"addedepoch": "1329863853",
"category": "2",
"city": "new-york",
"description": "a long description",
"hash": "193c0a69a0bde7e69ac5aad4c9b0cdad",
"highlights": "",
"id": "431344",
"image": "http://sidebuy.s3.amazonaws.com/13298638533187.jpg",
"link": "http://sidebuy.com/deals/affiliate/abc62ee1fd09c296fb9f45702063a374/4f1e0b1fd69228cd0f000146",
"loc": {
"latitude": 40.722976,
"longitude": -73.9999595
},
"merchant": {
"name": "Winter Beertopia",
"address": "82 Mercer Street New York, NY 10012",
"city": "",
"zip": "",
"state": "",
"country": "",
"tel": "",
"website": "http://www.iadventure.com"
},
"online": "false",
"original_price": "30.00",
"price": 15,
"provider": "pinchit",
"saving": "15.00",
"title": "50% Off VIP tickets",
"travel": "false"
