Module: node-foursquare/Venues

node-foursquare/Venues

A module for retrieving information about Venues from Foursquare.

Source:
../node-foursquare/lib/venues.js, line 1

Methods

<static> explore(lat, lng, [params], accessToken, callback)

Explore Foursquare Venues.

Source:
../node-foursquare/lib/venues.js, line 36
See:
  • https://developer.foursquare.com/docs/venues/explore.html
Parameters:
Name Type Argument Description
lat String | Number The latitude of the location around which to explore.
lng String | Number The longitude of the location around which to explore.
params Object <optional>
An object containing additional parameters. Refer to Foursquare documentation for details on currently supported parameters.
accessToken String The access token provided by Foursquare for the current user.
callback Function The function to call with results, function({Error} error, {Object} results).

<static> getCategories([params], accessToken, callback)

Retrieve a list of Venue Categories.

Source:
../node-foursquare/lib/venues.js, line 20
See:
  • https://developer.foursquare.com/docs/venues/categories.html
Parameters:
Name Type Argument Description
params Object <optional>
An object containing additional parameters. Refer to Foursquare documentation for details on currently supported parameters.
accessToken String The access token provided by Foursquare for the current user.
callback Function The function to call with results, function({Error} error, {Object} results).

<static> getHereNow(venueId, [params], [accessToken], callback)

Retrieve Check-ins for Users who are at a Venue "now".

Source:
../node-foursquare/lib/venues.js, line 160
See:
  • https://developer.foursquare.com/docs/venues/herenow.html
Parameters:
Name Type Argument Description
venueId String The id of a Foursquare Venue.
params Object <optional>
An object containing additional parameters. Refer to Foursquare documentation for details on currently supported parameters.
accessToken String <optional>
The access token provided by Foursquare for the current user.
callback Function The function to call with results, function({Error} error, {Object} results).

Retrieve Links for a Foursquare Venue.

Source:
../node-foursquare/lib/venues.js, line 232
See:
  • https://developer.foursquare.com/docs/venues/links.html
Parameters:
Name Type Argument Description
venueId String The id of a Foursquare Venue.
params Object <optional>
An object containing additional parameters. Refer to Foursquare documentation for details on currently supported parameters.
accessToken String <optional>
The access token provided by Foursquare for the current user.
callback Function The function to call with results, function({Error} error, {Object} results).

<static> getPhotos(venueId, [group], [params], [accessToken], callback)

Retrieve Photos for a Foursquare Venue.

Source:
../node-foursquare/lib/venues.js, line 208
See:
  • https://developer.foursquare.com/docs/venues/photos.html
Parameters:
Name Type Argument Default Description
venueId String The id of a Foursquare Venue.
group String <optional>
"venue" The type of photos to retrieve. Refer to Foursquare documentation for details on currently supported groups.
params Object <optional>
An object containing additional parameters. Refer to Foursquare documentation for details on currently supported parameters.
accessToken String <optional>
The access token provided by Foursquare for the current user. NOTE: This may or may not be required for certain types of photos associated to the venue. Refer to the Foursquare documentation for details.
callback Function The function to call with results, function({Error} error, {Object} results).

<static> getTips(venueId, [params], [accessToken], callback)

Retrieve Tips for a Foursquare Venue.

Source:
../node-foursquare/lib/venues.js, line 182
See:
  • https://developer.foursquare.com/docs/venues/tips.html
Parameters:
Name Type Argument Description
venueId String The id of a Foursquare Venue.
params Object <optional>
An object containing additional parameters. Refer to Foursquare documentation for details on currently supported parameters.
accessToken String <optional>
The access token provided by Foursquare for the current user.
callback Function The function to call with results, function({Error} error, {Object} results).

<static> getTrending(lat, lng, [params], [accessToken], callback)

Return Foursquare Venues near location with the most people currently checked in.

Source:
../node-foursquare/lib/venues.js, line 86
See:
  • https://developer.foursquare.com/docs/venues/trending.html
Parameters:
Name Type Argument Description
lat String | Number The latitude of the location around which to search.
lng String | Number The longitude of the location around which to search.
params Object <optional>
An object containing additional parameters. Refer to Foursquare documentation for details on currently supported parameters.
accessToken String <optional>
The access token provided by Foursquare for the current user.
callback Function The function to call with results, function({Error} error, {Object} results).

<static> getVenue(venueId, [accessToken], callback)

Retrieve a Foursquare Venue.

Source:
../node-foursquare/lib/venues.js, line 108
See:
  • https://developer.foursquare.com/docs/venues/venues.html
Parameters:
Name Type Argument Description
venueId String The id of a Foursquare Venue.
accessToken String <optional>
The access token provided by Foursquare for the current user.
callback Function The function to call with results, function({Error} error, {Object} results).

<static> getVenueAspect(venueId, aspect, [params], accessToken, callback)

Retrieve a specific aspect from the Venues endpoint.

Source:
../node-foursquare/lib/venues.js, line 132
See:
  • https://developer.foursquare.com/docs/index_docs.html
Parameters:
Name Type Argument Description
venueId String The id of a Foursquare Venue.
aspect String The aspect to retrieve. Refer to Foursquare documentation for details on currently supported aspects.
params Object <optional>
An object containing additional parameters. Refer to Foursquare documentation for details on currently supported parameters.
accessToken String The access token provided by Foursquare for the current user.
callback Function The function to call with results, function({Error} error, {Object} results).

Search Foursquare Venues.

Source:
../node-foursquare/lib/venues.js, line 61
See:
  • https://developer.foursquare.com/docs/venues/search.html
Parameters:
Name Type Argument Description
lat String | Number The latitude of the location around which to search.
lng String | Number The longitude of the location around which to search.
params Object <optional>
An object containing additional parameters. Refer to Foursquare documentation for details on currently supported parameters.
accessToken String <optional>
The access token provided by Foursquare for the current user.
callback Function The function to call with results, function({Error} error, {Object} results).