• Installs:
  • Today: 0
  • All Time: 308735
Developer:userserg.osipchuk

Foursquare API Package

Get Foursquare data and enable user/merchant interactions.

List of Endpoints
This is the list of endpoints this API includes. To add any of the endpoints to your app, please click on “Connect to endpoint” text.
See All
Discussions
See All
Readme

Foursquare

Foursquare Package

Add Foursquare venue and user information to your app.

  • Domain: foursquare.com
  • Credentials: clientId, clientSecret

How to get credentials:

Navigate to our OAuth Generator and follow the instructions there.

OR

Follow these steps:

  1. Create a new Foursquare Application
  2. Copy and save your clientId, clientSecret, redirectUrl
  3. Direct user to foursquare.com/oauth2/authenticate?client_id=clientId&response_type=code&redirect_uri=redirectUrl
  4. If the user accepts, they will be redirected back to http://YOUR_REGISTERED_REDIRECT_URI/?code=code
  5. Use getAccessToken method to get users's accessToken.

Custom datatypes:

DatatypeDescriptionExample
DatepickerString which includes date and time2016-05-28 00:00:00
MapString which includes latitude and longitude coma separated50.37, 26.56
ListSimple array["123", "sample"]
SelectString with predefined valuessample
ArrayArray of objects[{"Second name":"123","Age":"12","Photo":"sdf","Draft":"sdfsdf"},{"name":"adi","Second name":"bla","Age":"4","Photo":"asfserwe","Draft":"sdfsdf"}]

Foursquare.getAccessToken

Access tokens allow apps to make requests to Foursquare on the behalf of a user. Each access token is unique to the user and consumer key.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
codeStringThe authorization code.
redirectUriStringApplication redirect url.

Foursquare.getUser

Returns profile information for a given user, including selected mayorships.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
userIdStringIdentity of the user to get details for. Pass self to get details of the acting user.

Foursquare.getPendingFriendRequests

Shows a user the list of users with whom they have a pending friend request (i.e., someone tried to add the acting user as a friend, but the acting user has not accepted).

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.

Foursquare.findUsers

Helps a user locate friends.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
phoneStringA comma-delimited list of phone numbers to look for.
emailStringA comma-delimited list of email addresses to look for.
twitterStringA comma-delimited list of Twitter handles to look for.
twitterSourceStringA single Twitter handle. Results will be users that this handle follows on Twitter who use Foursquare.
facebookIdsStringA comma-delimited list of Facebook ID's to look for.
nameStringA single string to search for in users' names.
onlyPagesBoolean(default false) Indicates whether to only return pages. This replaces the functionality of the old dedicated pages/search endpoint.

Foursquare.getUserVisitedVenues

Returns a list of all venues visited by the specified user, along with how many visits and when they were last there.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
userIdStringFor now, only self is supported.
beforeTimestampNumberSeconds since epoch.
afterTimestampNumberSeconds after epoch.
categoryIdStringLimits returned venues to those in this category. If specifying a top-level category, all sub-categories will also match the query.

Foursquare.getUserPhotos

Returns photos from a user.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
userIdStringUser ID to retrieve photos for.
limitNumberNumber of results to return, up to 500.
offsetNumberUsed to page through results.

Foursquare.getUserCheckins

Returns a history of checkins for the authenticated user.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
userIdStringFor now, only self is supported
limitNumberNumber of results to return, up to 250.
offsetNumberThe number of results to skip. Used to page through results.
sortSelectHow to sort the returned checkins. Can be newestfirst or oldestfirst.
afterTimestampNumberRetrieve the first results to follow these seconds since epoch. This should be useful for paging forward in time, or when polling for changes. To avoid missing results when polling, we recommend subtracting several seconds from the last poll time and then de-duplicating.
beforeTimestampNumberRetrieve the first results prior to these seconds since epoch. Useful for paging backward in time.

Foursquare.getUserLikedVenues

Returns a list of venues liked by the specified user

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
userIdStringUser ID or self
beforeTimestampStringSeconds since epoch.
afterTimestampStringSeconds after epoch.
categoryIdStringLimits returned venues to those in this category. If specifying a top-level category, all sub-categories will also match the query.
limitNumberNumber of results to return.
offsetNumberUsed to page through results.

Foursquare.getUserMayorships

Returns a user's mayorships.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
userIdStringIdentity of the user to get mayorships for. Pass self to get friends of the acting user.

Foursquare.getUserLists

A User's Lists.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
userIdStringIdentity of the user to get lists for. Pass self to get lists of the acting user.
groupSelectCan be created (lists created by this user), edited (other people's lists this user has edited), followed (lists this user follows), friends (lists from this user's friends), and suggested (lists relevant to the user's current location).
locationMapLocation of the user, required in order to receive the suggested group. Format: lat,lng. Example: 40.7,-74
limitNumberNumber of results to return, up to 200.
offsetStringThe number of results to skip. Used to page through results.

Foursquare.updateUserPhoto

Updates the user's profile photo.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
photoFilePhoto under 100KB in multipart MIME encoding with content type image/jpeg, image/gif, or image/png.

Foursquare.getUserFriends

Returns an array of a user's friends.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
userIdStringIdentity of the user to get friends of. Pass self to get friends of the acting user.
limitNumberNumber of results to return, up to 500.
offsetNumberUsed to page through results.

Foursquare.getSingleVenue

Gives details about a venue, including location, mayorship, tags, tips, specials, and category.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
venueIdStringID of venue to retrieve

Foursquare.searchVenues

Returns a list of venues near the current location, optionally matching a search term.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
locationMapRequired unless near is provided: Latitude and longitude of the user's location. Format: lat,lng. Example: 40.7,-74
nearStringRequired unless location is provided: A string naming a place in the world. If the near string is not geocodable, returns a failed_geocode error. Otherwise, searches within the bounds of the geocode. Adds a geocode object to the response. (Required for query searches)
locationAccuracyFloatAccuracy of latitude and longitude, in meters. (Does not currently affect search results.)
altitudeNumberAltitude of the user's location, in meters. (Does not currently affect search results.)
altitudeAccuracyFloatAccuracy of the user's altitude, in meters. (Does not currently affect search results.)
queryStringA search term to be applied against venue names.
limitStringNumber of results to return, up to 50.
intentStringOne of the values below, indicating your intent in performing the search. If no value is specified, defaults to checkin. See README for more info.
radiusNumberLimit results to venues within this many meters of the specified location. Defaults to a city-wide area. Only valid for requests with intent=browse, or requests with intent=checkin and categoryId or query. Does not apply to match intent requests. The maximum supported radius is currently 100,000 meters.
southWestStringExample: 44.3,37.2. With northEast, limits results to the bounding quadrangle defined by the latitude and longitude given by sw as its south-west corner, and ne as its north-east corner. The bounding quadrangle is only supported for intent=browse searches. Not valid with ll or radius. Bounding quadrangles with an area up to approximately 10,000 square kilometers are supported.
northEastStringSee southWest.
categoryIdStringA comma separated list of categories to limit results to. If you specify categoryId specifying a radius may improve results. If specifying a top-level category, all sub-categories will also match the query. Does not apply to match intent requests.
urlStringA third-party URL which we will attempt to match against our map of venues to URLs.
providerIdStringIdentifier for a known third party that is part of our map of venues to URLs, used in conjunction with linkedId.
linkedIdString1002207971611 Identifier used by third party specified in providerId, which we will attempt to match against our map of venues to URLs.

Foursquare.getSuggestedCompletion

Returns a list of mini-venues partially matching the search term, near the location.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
queryStringA search term to be applied against titles. Must be at least 3 characters long.
locationMapRequired unless near is provided: Latitude and longitude of the user's location. Format: lat,lng. Example: 40.7,-74
nearStringRequired unless location is provided: A string naming a place in the world. If the near string is not geocodable, returns a failed_geocode error. Otherwise, searches within the bounds of the geocode. Adds a geocode object to the response. (Required for query searches)
locationAccuracyFloatAccuracy of latitude and longitude, in meters. (Does not currently affect search results.)
limitStringNumber of results to return, up to 100.
radiusStringLimit results to venues within this many meters of the specified location. Defaults to a city-wide area. The maximum supported radius is currently 80,000 meters.
southWestStringExample: 44.3,37.2. With northEast, limits results to the bounding quadrangle defined by the latitude and longitude given by sw as its south-west corner, and ne as its north-east corner. The bounding quadrangle is only supported for intent=browse searches. Not valid with ll or radius. Bounding quadrangles with an area up to approximately 10,000 square kilometers are supported.
northEastStringSee southWest.

Foursquare.getVenueCategories

Returns a hierarchical list of categories applied to venues.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.

Foursquare.getTrendingVenues

Returns a list of venues near the current location with the most people currently checked in.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
locationMapLocation of the user. Format: lat,lng. Example: 40.7,-74
limitNumberNumber of results to return, up to 50.
radiusStringRadius in meters, up to approximately 2000 meters.

Foursquare.getRecommendedVenues

Returns a list of recommended venues near the current location.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
locationMapRequired unless near is provided: Latitude and longitude of the user's location. Format: lat,lng. Example: 40.7,-74
nearStringRequired unless location is provided: A string naming a place in the world. If the near string is not geocodable, returns a failed_geocode error. Otherwise, searches within the bounds of the geocode. Adds a geocode object to the response. (Required for query searches)
locationAccuracyFloatAccuracy of latitude and longitude, in meters. (Does not currently affect search results.)
altitudeNumberAltitude of the user's location, in meters. (Does not currently affect search results.)
altitudeAccuracyFloatAccuracy of the user's altitude, in meters. (Does not currently affect search results.)
queryStringA search term to be applied against venue names.
radiusNumberRadius to search within, in meters. If radius is not specified, a suggested radius will be used based on the density of venues in the area.
sectionSelectOne of food, drinks, coffee, shops, arts, outdoors, sights, trending or specials, nextVenues (venues frequently visited after a given venue), or topPicks (a mix of recommendations generated without a query from the user). Choosing one of these limits results to venues with the specified category or property.
limitNumberNumber of results to return, up to 50.
offsetStringUsed to page through results.
noveltySelectPass newor old to limit results to places the acting user hasn't been or has been, respectively. Omitting this parameter returns a mixture of old and new venues.
friendVisitsSelectPass visited or notvisited to limit results to places the acting user's friends have or haven't been, respectively. Omitting this parameter returns a mixture of venues to which the user's friends have or haven't been.
timeStringPass any to retrieve results for any time of day. Omitting this parameter returns results targeted to the current time of day.
dayStringPass any to retrieve results for any day of the week. Omitting this parameter returns results targeted to the current day of the week.
venuePhotosNumberBoolean flag to include a photo in the response for each venue, if one is available. Default is 0 (no photos). Photos are returned as part of the venue JSON object.
lastVenueStringA venue ID to use in combination with the intent=nextVenues parameter, which returns venues users often visit after a given venue. If intent=nextVenues is specified but lastVenue is not, the user's last check-in will be used if it is within 2 hours. If the user has not checked in within the last 2 hours, no results will be returned.
openNowBooleanBoolean flag to only include venues that are open now. This prefers official provider hours but falls back to popular check-in hours.
sortByDistanceBooleanBoolean flag to sort the results by distance instead of relevance. Example: 1
priceStringComma separated list of price points. Currently the valid range of price points are [1,2,3,4], 1 being the least expensive, 4 being the most expensive. For food venues, in the United States, 1 is < $10 an entree, 2 is $10-$20 an entree, 3 is $20-$30 an entree, 4 is > $30 an entree.
savedBooleanBoolean flag to only include venues that the user has saved on their To-Do list or to another list.
specialsBooleanBoolean flag to only include venues that have a special.

Foursquare.addVenue

Allows Foursquare users to add a new venue.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
nameStringthe name of the venue
addressStringThe address of the venue.
crossStreetStringThe nearest intersecting street or streets.
cityStringThe city name where this venue is.
stateStringThe nearest state or province to the venue.
zipStringThe zip or postal code for the venue.
phoneStringThe phone number of the venue.
twitterStringThe twitter handle of the venue.
locationMapLatitude and longitude of the venue, as accurate as is known. Format: lat,lng. Example: 40.7,-74
primaryCategoryIdStringThe ID of the category to which you want to assign this venue.
descriptionStringA freeform description of the venue, up to 160 characters.
urlStringThe url of the homepage of the venue.
ignoreDuplicatesBooleanA boolean flag telling the server to ignore duplicates and force the addition of this venue.
ignoreDuplicatesKeyStringRequired if ignoreDuplicates is true. This key will be available in the response of the HTTP 409 error of the first (failed) attempt to add venue.

Foursquare.getUserManagedVenues

Get a list of venues the current user manages.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
limitNumberNumber of managed venues to return. Defaults to 100, maximum is 1000.
offsetNumberNumber of venues to skip over for paging. Defaults to 0.

Foursquare.getSimilarVenues

Returns a list of venues similar to the specified venue.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
venueIdStringThe venue you want similar venues for.

Foursquare.getVenuePhotos

Returns photos for a venue.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
venueIdStringThe venue id for which photos are being requested.
groupStringIf not specified, public venue photos are returned ordered by relevance. Pass venue for public venue photos, ordered by recency. Pass checkin for venue photos from friends (including non-public photos from recent checkins), ordered by recency. See our documentation on photos for information on how to handle the response and construct actual photo URLs.
limitNumberNumber of results to return, up to 200.
offsetNumberUsed to page through results.

Foursquare.getVenueEvents

Allows you to access information about the current events at a place.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
venueIdStringThe venue id for which events are being requested.

Foursquare.getUsersWhoLikedVenue

Returns friends and a total count of users who have liked this venue.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
venueIdStringThe ID of the venue to get likes for.

Foursquare.getNextVenues

Returns venues that people often check in to after the current venue. Up to 5 venues are returned in each query, and results are sorted by how many people have visited that venue after the current one. Homes are never returned in results.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
venueIdStringID of the venue you want to see next venue information about

Foursquare.getVenueHours

Returns hours for a venue.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
venueIdStringThe venue id for which hours are being requested.

Foursquare.getVenueLinks

Returns URLs or identifiers from third parties that have been applied to this venue, such as how the New York Times refers to this venue and a URL for additional information from nytimes.com. This is part of the foursquare Venue Map.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
venueIdStringThe venue you want annotations for.

Foursquare.getVenueMenu

Returns menu information for a venue.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
venueIdStringThe venue id for which menu is being requested.

Foursquare.getVenueTips

Returns tips for a venue.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
venueIdStringThe venue you want tips for.
sortSelectOne of friends, recent, or popular.
limitStringNumber of results to return, up to 500.
offsetStringUsed to page through results.

Foursquare.getVenuePeopleCount

Provides a count of how many people are at a given venue.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
venueIdStringID of venue to retrieve
limitNumberNumber of results to return, up to 500.
offsetNumberUsed to page through results.

Foursquare.claimVenue

Claim a venue for the user. If your OAuth Consumer is set up with the proper privileges, you can use this endpoint to claim a venue on behalf of a user without the claim having to be approved by foursquare staff.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
visibleBoolean(optional, default true) whether role as manager is visible on the venue page

Foursquare.dislikeVenue

Allows the acting user to dislike for a venue.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
venueIdStringThe venue to dislike for

Foursquare.undoDislikeVenue

Allows the acting user to undo a previous dislike for a venue.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
venueIdStringThe venue to undo a dislike for

Foursquare.flagVenue

Allows users to indicate a venue is incorrect in some way.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
venueIdStringThe venue id for which an edit is being proposed.
problemSelectOne of mislocated, closed, duplicate, inappropriate, doesnt_exist, event_over
dublicatedVenueStringID of the duplicated venue (for problem duplicate)

Foursquare.proposeVenueChange

If the user knows the correct venue information, use this method to save it. Otherwise, use flag to flag the venue instead (you need not specify new venue info in that case).

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
venueIdStringThe venue id for which an edit is being proposed.
nameStringThe name of the venue.
addressStringThe address of the venue.
crossStreetStringThe nearest intersecting street or streets.
cityStringThe city name where this venue is.
stateStringThe nearest state or province to the venue.
zipStringThe zip or postal code for the venue.
phoneStringThe phone number of the venue.
twitterStringThe twitter handle of the venue.
descriptionStringA freeform description of the venue, up to 300 characters.
urlStringThe url of the homepage of the venue.
menuUrlStringA url where the menu of the venue can be found.
facebookUrlStringThe url for this venue's Facebook Page.
venueLocationMapLatitude and longitude at which the venue should be located. Example: 44.3,37.2
primaryCategoryIdStringThe ID of the category to which you want to assign this venue.
addCategoryIdsStringComma-separated list of new category IDs to be assigned to this venue. If you are adding a new category to a venue and you want to make it primary, you should just use primaryCategoryId.
removeCategoryIdsStringComma-separated list of new category IDs to be removed from this venue.
hoursStringThe hours for the venue, as a semi-colon separated list of open segments and named segments (e.g., brunch or happy hour). Open segments are formatted as day,start,end. Named segments additionally have a label, formatted as day,start,end,label. Days are formatted as integers with Monday = 1,...,Sunday = 7. Start and End are formatted as [+]HHMM format. Use 24 hour format (no colon), prefix with 0 for HH or MM less than 10. Use '+' prefix, i.e., +0230 to represent 2:30 am past midnight into the following day.

Foursquare.likeVenue

Allows the acting user to like a venue.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
venueIdStringThe venue to like

Foursquare.unlikeVenue

Allows the acting user to unlike a venue.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
venueIdStringThe venue to unlike

Foursquare.getVenueGroups

List all venue groups owned by the user.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.

Foursquare.getCheckin

Get details of a check-in.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
checkinIdStringThe ID of the check-in to retrieve additional information for.

Foursquare.resolvePublicCheckinFromUrl

Check-ins that are posted to public feeds such as Twitter do not reveal the associated check-in's ID. Use this endpoint to map from a check-in URL (e.g., https://www.swarmapp.com/c/fcP5m3yn7AL) to check-in details.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
shortIdStringThe short ID at the end of a swarmapp.com link, e.g., https://swarmapp.com/c/abc123ZYX

Foursquare.getRecentFriendsCheckins

Returns a list of recent checkins from friends.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
locationMapLatitude and longitude of the user's location, so response can include distance. Format: lat,lng. Example: 40.7,-74
limitNumberNumber of results to return, up to 100.
afterTimestampNumberSeconds after which to look for checkins, e.g. for looking for new checkins since the last fetch. If more than limit results are new since then, this is ignored. Checkins created prior to this timestamp will still be returned if they have new comments or photos, making it easier to poll for all new activity.

Foursquare.createCheckin

Allows you to check in to a place.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
venueIdStringThe venue where the user is checking in. Find venue IDs by searching or from historical APIs.
eventIdStringThe event the user is checking in to.
shoutStringA message about your check-in. The maximum length of this field is 140 characters.
mentionsSelectMentions in your check-in. This parameter is a semicolon-delimited list of mentions. A single mention is of the form start,end,userid, where start is the index of the first character in the shout representing the mention, end is the index of the first character in the shout after the mention, and userid is the userid of the user being mentioned. If userid is prefixed with 'fbu-', this indicates a Facebook userid that is being mention. Character indices in shouts are 0-based.
broadcastSelectWho to broadcast this check-in to. Accepts a comma-delimited list of values: private, public, facebook, twitter, followers
locationMapLatitude and longitude of the user's location. Only specify this field if you have a GPS or other device reported location for the user at the time of check-in. Format: lat,lng. Example: 40.7,-74
locationAccuracyFloatAccuracy of latitude and longitude, in meters.
altitudeNumberAltitude of the user's location, in meters.
altitudeAccuracyFloatAccuracy of the user's altitude, in meters.

Foursquare.getUsersWhoLikedCheckin

Returns friends and a total count of users who have liked this checkin.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
checkinIdStringThe ID of the checkin to get likes for.

Foursquare.removeCommentFromCheckin

Remove a comment from a checkin, if the acting user is the author or the owner of the checkin.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
checkinIdStringThe ID of the checkin to remove a comment from.
commentIdStringThe id of the comment to remove.

Foursquare.likeCheckin

Allows the acting user to like a checkin.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
checkinIdStringChecking id to like

Foursquare.unlikeCheckin

Allows the acting user to unlike a checkin.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
checkinIdStringChecking id to unlike

Foursquare.addPostToCheckin

Post user generated content from an external app to a check-in. This post will be accessible to anyone who can view the details of the check-in.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
checkinIdStringThe ID of the checkin to add a post to.
textStringThe text of the post, up to 200 characters.
urlStringLink for more details. This page will be opened in an embedded web view in the foursquare application, unless contentId is specified and a native link handler is registered and present. We support the following URL schemes: http, https, foursquare, mailto, tel, and sms.
contentIdStringIdentifier for the post to be used in a native link, up to 50 characters. A url must also be specified in the request.

Foursquare.addCommentToCheckin

Comment on a checkin-in

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
checkinIdStringThe ID of the checkin to add a comment to.
textStringThe text of the comment, up to 200 characters.
mentionsStringMentions in your check-in. This parameter is a semicolon-delimited list of mentions. A single mention is of the form start,end,userid, where start is the index of the first character in the shout representing the mention, end is the index of the first character in the shout after the mention, and userid is the userid of the user being mentioned. Character indices in shouts are 0-based.

Foursquare.getTip

Gives details about a tip, including which users (especially friends) have marked the tip to-do.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
tipIdStringID of tip to retrieve

Foursquare.addTip

Allows you to add a new tip at a venue.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
venueIdStringThe venue where you want to add this tip.
textStringThe text of the tip, up to 200 characters.
urlStringA URL related to this tip.
broadcastStringWhether to broadcast this tip. Send twitter if you want to send to twitter, facebook if you want to send to facebook, or twitter,facebook if you want to send to both.

Foursquare.getUsersWhoLikedTip

Returns friends and a total count of users who have liked this tip.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
tipIdStringThe ID of the tip to get likes for.

Foursquare.getUsersSavedTip

Returns friends and a total count of users who have saved this tip.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
tipIdStringThe ID of the tip to get saves for.

Foursquare.getListsTipAppears

The lists that this tip appears on.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
tipIdStringIdentity of a tip to get lists for.
groupSelectcan be created, edited, followed, friends, other. If no acting user is present, only other is supported.

Foursquare.removeTipFromToDoList

Allows you to remove a tip from your to-do list.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
tipIdStringThe tip you want to unmark.

Foursquare.flagTip

Allows the acting user to flag a tip as offensive, spam, or not relevant.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
tipIdStringThe tip to flag.
commentStringA comment explaining the flag.
problemSelectThe specific problem with the tip. Must be one of offensive, spam, or nolongerrelevant.

Foursquare.likeTip

Allows the acting user to like a tip.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
tipIdStringThe tip to like.

Foursquare.unlikeTip

Allows the acting user to like a tip.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
tipIdStringThe tip to unlike.

Foursquare.getSingleList

Gives details about a list.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
listIdStringId for a user-created (e.g. /v2/lists/12381902N) or followed list or one of either USER_ID/tips (e.g. /v2/lists/32/tips) or USER_ID/todos.
limitStringNumber of results to return, up to 200.
offsetStringThe number of results to skip. Used to page through results.
locationBoundsStringThe number of results to skip. Used to page through results. Example: 30.13800,-98.16009,30.40485,-97.28118
categoryIdStringRestricts the returned results to venues matching the input category id.
sortStringSorts the list items. Possible values are recent and nearby. recent sorts the list items by the date added to the list. nearby sorts the list items by the distance from the center of the provided llBounds.

Foursquare.addList

Allows users to create a new list.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
nameStringRequired The name of the list.
descriptionStringThe description of the list.
collaborativeStringBoolean indicating if this list can be edited by friends.
photoIdStringThe id of a photo that should be set as the list photo.

Foursquare.getListFollowers

Returns a count and items of users following this list.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
listIdStringId for a user-created list

Foursquare.suggestItemListPhotos

Suggests photos that may be appropriate for this item.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
listIdStringId for a user-created list.
itemIdStringId of item on this list.

Foursquare.suggestListTips

Suggests tips that may be appropriate for this item.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
listIdStringId for a user-created list.
itemIdStringId of item.

Foursquare.getListItem

Gives details about a list item

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
listIdStringId for a user-created or followed list.
itemIdStringId for an item in the parent list.

Foursquare.suggestVenuesForList

Suggests venues that may be appropriate for this list.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
listIdStringId for a user-created list

Foursquare.updatesList

Allows you to update a list.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
listIdStringId for a user-created list.
nameStringIf present and a non-empty value, updates the List name.
descriptionStringIf present and a non-empty value, updates the List description. If present and empty, will remove the List description.
collaborativeStringBoolean indicating if this list can be edited by friends. Once this has been set to true for a list, authenticated friends can edit the list via additem, deleteitem, etc.
photoIdStringIf present and a non-empty value, updates the List photo. If present and empty, will remove the List photo.

Foursquare.deleteItemFromList

Allows you to delete items from a list. One of itemId, venueId, or tipId must be provided.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
listIdStringId for a user-created or followed list or one of either USER_ID/tips or USER_ID/todos.
itemIdStringId of the item to delete.
venueIdStringId of a venue to be deleted. If the venue is on the list multiple times, e.g. multiple tips at the same venue, all items will be removed.
tipIdStringId of a tip to be deleted.

Foursquare.updateListItem

Allows you to add or remove photos and tips from items on user-created lists. Note: Only valid on user-created lists Note: Collaborators can only update items they added. List owners can not update any item.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
listIdStringId for a user-created list.
itemIdStringId of the item to update.
tipIdStringIf present and a non-empty value, adds or replaces a tip on this item. If present and empty, will remove the tip on this item.
textStringIf present creates a public tip on the venue and replaces any existing tip on the item. Cannot be used in conjuction with tipId or photoId
urlStringIf adding a new tip via text, this can associate a url with the tip.
photoIdStringIf present and a non-empty value, adds a photo to this item. If present and empty, will remove the photo on this item. If the photo was a private checkin photo, it will be promoted to a public venue photo.

Foursquare.followList

Allows you to follow a list.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
listIdStringId of a user-created list.

Foursquare.unfollowList

Allows you to unfollow a list.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
listIdStringId of a user-created list.

Foursquare.moveItemOnList

Allows you to move an item on a list. One of beforeId or afterId must be specified.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
listIdStringId of a user-created list.
itemIdStringId of the item on this list to move.
beforeIdStringMove itemId before beforeId.
afterIdStringMove itemId after afterId.

Foursquare.shareList

Share a user-created list to twitter or facebook.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
listIdStringList id to share.
broadcastStringWhere to broadcast this list. Send twitter if you want to send to twitter, facebook if you want to send to facebook, or twitter,facebook if you want to send to both.
messageStringA personal note to include with the share.

Foursquare.addItemToList

Allows you to add an item to a list.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
followedListIdStringId for a user-created or followed list as well as one of either USER_ID/tips or USER_ID/todos.
venueIdStringA venue to add to the list.
urlStringIf adding a new tip via text, this can associate a url with the tip.
tipIdStringUsed to add a tip to a list. Cannot be used in conjunction with the text and url fields.
listIdStringUsed in conjuction with itemId, the id for a user created or followed list as well as one of either USER_ID/tips or USER_ID/todos.
itemIdStringUsed in conjuction with listId, the id of an item on that list that we wish to copy to this list.

Foursquare.getUpdateDetails

Allows you to retrieve update details.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
updateIdStringThe ID of the update to retrieve

Foursquare.getNotificationUpdates

Retrieve a user's notification tray notifications

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
limitStringMaximum number of results to return, up to 99. Notifications are grouped over time, so there will usually be fewer than 99 results available at any given time. offset 0 Used to page through results. Only the 99 most recent notifications are visible, so offset must be no more than 99 - limit.

Foursquare.markNotificationsAsRead

Mark notification tray notifications as read up, to a certain timestamp.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
highWatermarkStringThe timestamp of the most recent notification that the user viewed.

Foursquare.getPhoto

Get details of a photo.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
photoIdStringThe ID of the photo to retrieve additional information for.

Foursquare.getSingleSetting

Returns a setting for the acting user.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
settingIdStringThe name of a setting.

Foursquare.getUserSettings

Returns the settings of the acting user.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.

Foursquare.changeSingleSetting

Change a setting for the given user.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
settingIdStringName of setting to change, sendMayorshipsToTwitter, sendBadgesToTwitter, sendMayorshipsToFacebook, sendBadgesToFacebook, receivePings, receiveCommentPings.
valueNumber1 for true, and 0 for false.

Foursquare.searchSpecials

Returns a list of specials near the current location.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
locationSelectLatitude and longitude to search near. Format: lat,lng. Example: 40.7,-74
radiusNumberLimit results to venues within this many meters of the specified location. Defaults to a city-wide area.
locationAccuracyFloatAccuracy of latitude and longitude, in meters.
altitudeNumberAltitude of the user's location, in meters.
altitudeAccuracyFloatAccuracy of the user's altitude, in meters.
limitNumberNumber of results to return, up to 50.

Foursquare.getSingleEvent

Get details of a event.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
eventIdStringThe ID of the event to retrieve additional information for.

Foursquare.searchEvents

This is an experimental API and subject to change or breakage.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
domainStringIdentifier for a known third-party event provider. This is used in conjunction with id. Currently songkick.com is the only supported value.
eventIdStringIdentifier used by third-party specifed in domain, which we will attempt to match against our events listings. eventId is the id of an event, participantId is the id of a participant, like a band or sports team.
participantIdStringIdentifier used by third-party specifed in domain, which we will attempt to match against our events listings. eventId is the id of an event, participantId is the id of a participant, like a band or sports team.

Foursquare.getEventCategories

Returns a hierarchical list of categories applied to events.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.

Foursquare.getUserManagedPages

Returns an array of the pages a user manages.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.

Foursquare.addPage

Allows users to create a new page. The creating user is added as a manager of the new page.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
nameStringThe name of the page

Foursquare.getPageVenuesTimeSeriesData

Get daily venue stats for venues managed by a page over a time range.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
pageIdStringThe page whose venues to get timeseries data for
startAtStringThe start of the time range to retrieve stats for (seconds since epoch).
endAtStringThe end of the time range to retrieve stats for (seconds since epoch). If omitted, the current time is assumed.
fieldsStringSpecifies which fields to return. May be one or more of totalCheckins, newCheckins, uniqueVisitors, sharing, genders, ages, hours, separated by commas.

Foursquare.getPageAccessToken

Returns an OAuth access token for the specified page. The requesting user must be a manager of the page.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
userIdStringThe page you want similar pages for.

Foursquare.getPageVenues

Allows you to get the page's venues.

FieldTypeDescription
clientIdcredentialsApplication client id.
clientSecretcredentialsApplication client secret key.
pageIdStringThe page whose venues to get venues for
locationStringNot valid with ne or sw. Limits results to venues near this latitude and longitude within an optional radius.
radiusNumberCan be used when including ll. Not valid with ne or sw. Limit results to venues within this many meters of the specified ll. The maximum supported radius is currently 100,000 meters.
southWestMapExample: 44.3,37.2. With northEast, limits results to the bounding quadrangle defined by the latitude and longitude given by sw as its south-west corner, and ne as its north-east corner. The bounding quadrangle is only supported for intent=browse searches. Not valid with ll or radius. Bounding quadrangles with an area up to approximately 10,000 square kilometers are supported.
northEastStringSee southWest.
offsetNumberThe offset of which venues to return. Defaults to 0.
limitNumberThe number of venues to return. Defaults to 20, max of 100.
storeIdNumberOnly return venues whose storeId matches. storeIds are defined by the page manager (and therefore namespaced to that particular page). They are the page's own internal identifier for that venue. Cannot be used with any geo params.

Foursquare.getSinglePageUpdate

Get page update details.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
updateIdStringThe ID of the update to retrieve additional information for.
limitStringThe number of nearby venues to show (default 20).
locationStringThe location of the current user.

Foursquare.getPageUpdates

Returns a list of page updates created by the current user.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.

Foursquare.likePageUpdate

Causes the current user to 'like' a page update. If there is a campaign associated with the update, the like will propagate to the special as well.

FieldTypeDescription
accessTokenStringAccess Token obtained from Foursquare OAuth.
updateIdStringThe ID of the update to like.
x
circle
Foursquare
$ / m
We will charge your card every month for the plan amount, as well as any overages incurred in the previous month.
?

Oops, we are missing some details

Looks like there are a few missing details that you haven't filled in yet.
These details are important and will help us protect you and let you know about anything new.

x

Why sign up to RapidAPI?

  • integrate
    Integrate APIs into your app
    Ruby, Java, Elixir, Node.js, Phyton, Objective C, Swift, PHP and MORE
  • keys
    Save all API keys in one place
  • notifications
    Get notifications about API changes
  • stats
    Get stats and monitor API connections
__SING_UP_WITH_GITHUB__
__SING_UP_WITH_FACEBOOK__
__SING_UP_WITH_GOOGLE__
  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Authentication

    Authenticate
    esccloses this view