Last 7 days, UTC

Average Latency
37ms

Average Uptime
100.0%

Current Status
Online

  • No information
  • Outage
  • Disruption
  • Normal
Average latency determined from Mashape to API Response time

Endpoints

HTTP 200 : Categories GET/categories
						{"categories":[{"aliases":["cafe, bistro, bar"],"name":"Restaurants","offers_count":"Number of available offers in category"}]}						
Catgories

This call serves as a reference of the categories in our system. It also includes a count of the active offers in that category. Categories are ordered alphabetically.


HTTP 200 : Commissions GET/providers
						{"commissions":[{"amount":5.95,"metadata":{},"occurred_at":"2011-07-28 16:17:56 -0500","offer_id":45009,"provider":"Groupon"}]}						
Commissions

You can always see your earnings on your dashboard. But you can also ask our API for your commissions.


Test console
Description
Parameter
string

Your secret token authorizing your account
Example: fdip394iodshfluh34

authentication_token

Required

string

Restrict commissions occurring after given date.
Example: 2011-03-01

from

Optional

string

Restrict commissions occurring before given date.
Example: 2011-03-01

to

Optional

HTTP 200 : PaginatedOffers GET/offers
						{"offers":{"offer":[{"description":"<p>Enjoy more crab than you've ever eaten in your life....and lobster, tuna, tillapia</p>","discount":51,"expires_at":"2011-07-21T23:59:59-05:00","expires_at_in_words":"about 11 hours","id":372999,"image":["[\r\n          \"http://images.sqoot.com/production/offers/372999/tiny.png\",\r\n          \"http://images.sqoot.com/production/offers/372999/small.png\",\r\n          \"http://images.sqoot.com/production/offers/372999/medium.png\",\r\n          \"http://images.sqoot.com/production/offers/372999/large.png\",\r\n          \"http://images.sqoot.com/production/offers/372999/huge.png\",\r\n          \"http://images.sqoot.com/production/offers/372999/tiny_square.png\",\r\n          \"http://images.sqoot.com/production/offers/3"],"locations":[{"city":"Topeka","country":"US","latitude":-95.80252,"longitude":39.047024,"name":"Crab Shack","state":"KS","street_address_1":"6121 SW 12th St","zip":66615}],"price":49.0,"short_title":"51% off at Crab Shack","source":"Groupon","title":"$49 for $100 gift card for delicious crab ($100 value)","url":"http://click.sqoot.com/372999","value":100.0}]},"page":5,"per_page":3,"total":32001}						
Offers

This is the primary call in our API. With a rich set of parameters you should be able to slice and dice our collection of offers with ease.


Test console
Description
Parameter
string

To track impressions, clicks and sales include your affiliate token with each request.
Example: jh3g45uykg3j2h4g2j3kh

affiliate_token

Optional

string

A comma separated list of categories to restrict results.
Example: Active,Fitness

categories

Optional

string

Just like categories, but excludes specified categories.
Example: Restaurants

categories_not

Optional

number

Exact discount percentage
Example: 50

discount

Optional

number

Minimum discount percentage
Example: 50

discount_at_least

Optional

number

Maximum discount percentage
Example: 50

discount_at_most

Optional

string

Searches for deals that match all of the comma separated phrases.
Example: pilates,bikram

keywords_all

Optional

string

Searches for deals that match any of the comma separated phrases.
Example: pilates,bikram

keywords_any

Optional

string

Searches for deals that do not match any of the comma separated phrases. Known bug: must be used with keywords_any or keywords_all.
Example: pilates,bikram

keywords_not

Optional

string

We resolve this string to an actual point on a map and search for deals near there. Have coordinates? No problem? Use this format: "[latitude],[longitude]". No location? No problem? By default we resolve to the caller's IP address.
Example: Chicago

location

Optional

string

Defaults to Sqoot’s "best-deal" algorithm (recommended). Other options include: price(_desc), value(_desc), discount(_desc), expires_at(_desc), distance (ignored if location is blank)
Example: discount

order

Optional

number

Page number
Example: 2

page

Optional

number

Number of results per page. Defaults to 10. Maximum of 10.
Example: 5

per_page

Optional

number

Exact price in dollars
Example: 15

price

Optional

number

Minimum price in dollars
Example: 15

price_at_least

Optional

number

Maximum price in dollars
Example: 15

price_at_most

Optional

string

A comma separated list of provider names to restrict results.
Example: Groupon,TownHog

providers

Optional

string

Just like providers, but excludes specified providers.
Example: SeatGeek

providers_not

Optional

string

This will perform a full-text search against our offer titles and descriptions, ordering results by relevance.
Example: yoga

query

Optional

number

Specify a number of miles to restrict offers to. Ignored if location is blank.
Example: 10

radius

Optional

number

Exact value in dollars
Example: 30

value

Optional

number

Minimum value in dollars
Example: 30

value_at_least

Optional

number

Maximum value in dollars
Example: 30

value_at_most

Optional

HTTP 200 : Providers GET/providers
						{"providers":[{"name":"Groupon","offers_count":"Number of available offers"}]}						
Providers

This call serves as a reference of the active providers in our system. It also includes a count of the active offers for that provider. Providers are ordered alphabetically. Note that offer counts change frequently. Also note that an offer's source as returned from Offers is not always its provider (e.g. an offer's provider may be "Lifesta" but its source could be "Groupon").


Consume this API completely for free!


By joining the mashape API marketplace you can start using Sqoot API today!

Login to your account or signup: Create Account

or
   Signup with GitHub

By signing up you agree to our terms of service.