API Information
This is a brief overview of the Noster API
General Notes

For more details on the end-point, please click here

There are some details common to all API end points.

Arguments

All API end points take arguments in a standard format of argument_name/argument_value. For example, to include links, you need to append /include_links/1 to the URL. You may add as many arguments as desired in this manner.

Name Description Type Options
include_columns Should the response include a description of the columns available in the query Bool
include_links Should the response include a list of links for the list Bool
include_styles Should the response include a list of styles available in the list Bool
item_id The ID of an item required when requesting a single item or a link Integer
limit The maximum number of items wanted in the response. The maximum allowed value is 1000 Integer
format The format in which we want the data returned Enum json,xml
user_id The ID of the user accessing the API Call Integer
session_key The session key returned for the user when logging in Text
Basic Login

You can use this endpoint to complete a basic login to the system. This allows you to submit your email address and password and the response includes a webservice token that you can use for accessing other API endpoints. For the moment, you can just use your own credentials for this end-point for for multi-user access, we will extend this functionality to allow for Application Keys

POST /index.php/api/login HTTP/1.1

Host: https://api.noster.info

Arguments

The login end-point takes the following arguments. Remember that for login end points, all arguments must be POSTed

Name Description Type Options
email The email address associated with the login account Text
password The password for the account Text
format The format in which we want the data returned Enum json,xml

Response

The following fields are displayed in the result of this api query

Field Name Title Description Type Length Options
id ID The ID for the logged in user Integer
session_token Session Token The session token for the logged in user Text 80
access_time Access Time The time of the user accesss Text 80
name Name The name of the user's account Text 80
organisation_id Organisation ID The ID for the logged in user's organisation Integer
organisation_name Organisation Name The name of the user's organisation Text 80
{
  "id": 1234,
  "session_token": "XXXXXXXXXXXXXXXX",
  "access_time": "2017-12-11 12:18:41",
  "name": "API User",
  "organisation_id": 1,
  "organisation_name": "Noster Mobile"
}
Facebook Login

You can use this endpoint to complete a facebook login to the system. This works in conjunction with the Facebook login button or iOS/Android library. The idea is to allow you to validate a Facebook user ID and access token and thus grant access to the validated user. If the email address associated with the Facebook user or the facebook user ID is in the system, and the access token validates, then that user will be granted access to the API based on the validation. By providing an email address and password, this API allows you to attach a facebook account to a previously logged in user. See Facebook developer documentation for more details.

POST /index.php/api/login_facebook HTTP/1.1

Host: https://api.noster.info

Arguments

Name Description Type Options
facebook_id The Facebook ID of the user logging in Bigint
facebook_token The Facebook access token of the user logging in. This is obtained from the facebook login button. Text
format Optional - The format in which we want the data returned Enum json,xml
user_id Optional - The ID of the user accessing the API Call Integer
session_key Optional - The session key returned for the user when logging in Text

Response

The following fields are displayed in the result of this api query

Field Name Title Description Type Length Options
id ID The ID for the logged in user Integer
session_token Session Token The session token for the logged in user Text 80
access_time Access Time The time of the user accesss Text 80
name Name The name of the user's account Text 80
organisation_id Organisation ID The ID for the logged in user's organisation Integer
organisation_name Organisation Name The name of the user's organisation Text 80
{
  "id": 1234,
  "session_token": "XXXXXXXXXXXXXXXX",
  "access_time": "2017-12-11 12:18:41",
  "name": "API User",
  "organisation_id": 1,
  "organisation_name": "Noster Mobile"
}
Twitter Login

You can use this endpoint to complete a Twitter login to the system. This works in conjunction with the Twitter login button or iOS/Android library. The idea is to allow you to validate a Twitter user ID and access token and thus grant access to the validated user. If the Twitter user ID is in the system, and the access token validates, then that user will be granted access to the API based on the validation. By providing an email address and password, this API allows you to attach a facebook account to a previously logged in user. See Twitter developer documentation for more details.

POST /index.php/api/login_twitter HTTP/1.1

Host: https://api.noster.info

Arguments

Name Description Type Options
twitter_id The Twitter ID of the user logging in Bigint
twitter_handle The Twitter handle of the user logging in Bigint
twitter_token The Twitter access token of the user logging in. This is obtained from the facebook login button. Text
twitter_secret The Twitter secret of the user logging in. This is obtained from the facebook login button. Text
format Optional - The format in which we want the data returned Enum json,xml
user_id Optional - The ID of the user accessing the API Call Integer
session_key Optional - The session key returned for the user when logging in Text

Response

The following fields are displayed in the result of this api query

Field Name Title Description Type Length Options
id ID The ID for the logged in user Integer
session_token Session Token The session token for the logged in user Text 80
access_time Access Time The time of the user accesss Text 80
name Name The name of the user's account Text 80
organisation_id Organisation ID The ID for the logged in user's organisation Integer
organisation_name Organisation Name The name of the user's organisation Text 80
{
  "id": 1234,
  "session_token": "XXXXXXXXXXXXXXXX",
  "access_time": "2017-12-11 12:18:41",
  "name": "API User",
  "organisation_id": 1,
  "organisation_name": "Noster Mobile"
}
Instagram Login

You can use this endpoint to complete a Instagram login to the system. This works in conjunction with the Instagram login button or iOS/Android library. The idea is to allow you to validate a Instagram user ID and access token and thus grant access to the validated user. If the Instagram user ID is in the system, and the access token validates, then that user will be granted access to the API based on the validation. By providing an email address and password, this API allows you to attach a facebook account to a previously logged in user. See Instagram developer documentation for more details.

POST /index.php/api/login_instagram HTTP/1.1

Host: https://api.noster.info

Arguments

Name Description Type Options
instagram_id The Instagram ID of the user logging in Bigint
instagram_token The Instagram access token of the user logging in. This is obtained from the instagram login button. Text
format Optional - The format in which we want the data returned Enum json,xml
user_id Optional - The ID of the user accessing the API Call Integer
session_key Optional - The session key returned for the user when logging in Text

Response

The following fields are displayed in the result of this api query

Field Name Title Description Type Length Options
id ID The ID for the logged in user Integer
session_token Session Token The session token for the logged in user Text 80
access_time Access Time The time of the user accesss Text 80
name Name The name of the user's account Text 80
organisation_id Organisation ID The ID for the logged in user's organisation Integer
organisation_name Organisation Name The name of the user's organisation Text 80
{
  "id": 1234,
  "session_token": "XXXXXXXXXXXXXXXX",
  "access_time": "2017-12-11 12:18:41",
  "name": "API User",
  "organisation_id": 1,
  "organisation_name": "Noster Mobile"
}
All Venues

For more details on the All Venues end-point, please click here

Read List

This end-point is used to read a list of items in this view

POST /index.php/api/v1/all_venues HTTP/1.1

Host: https://api.noster.info

Arguments

The All Venues end-point takes the following arguments in addition to the standard switches

Name Description Type Options
geo_center The latitude,longitude pair for the centre of the required geographic area Point
geo_min_distance The minimum distance from the centre in metres for which points are required Integer
geo_max_distance The maximum distance from the centre for which points are required Integer
chain_id The chain ID for the venue Integer
location_id The location id for the venue Integer
osm_data_set_id Data set from which this venue was imported Integer
item_id The ID of an item required when requesting a single item or a link Integer
limit The maximum number of items wanted in the response. The maximum allowed value is 100 Integer
format The format in which we want the data returned Enum json,xml
user_id The ID of the user accessing the API Call Integer
session_key The session key returned for the user when logging in Text

Fields

The following fields are displayed in the result of this api query

Field Name Title Description Type Length Options
distance distance String
name name Name of the venue String 256
image image URL for an image associated with this pulse String 512
facebook_id facebook_id Facebook id for the venue String 256
facebook_page facebook_page Facebook page for the venue String 256
twitter_handle Twitter Handle Facebook page for the venue String 256
instagram_page Instagram Page Reference to the youtube account for the venue String 255
yelp_page yelp_page The primary value for the property Textarea 65535
deliveroo_page deliveroo_page The primary value for the property Textarea 65535
opentable_page opentable_page The primary value for the property Textarea 65535
golocal_page golocal_page The primary value for the property Textarea 65535
id id Primary Key for the table Int 11
hopr_score hopr_score The GLOBAL Hoppiness value for this venue Int 11
categories categories List of text categories - probably temporary Textarea 65535
tags tags Tags for this venue Textarea 65535
phone phone The phone number for the venue String 256
website website The website URL for the venue Textarea 65535
pinterest_page pinterest_page Reference to the youtube account for the venue String 255
youtube_page youtube_page Reference to the youtube account for the venue String 255
tripadvisor_page tripadvisor_page Tripadvisor URL for the venue String 256
latitude latitude Latitude for the venue Double 20,15
longitude longitude Longitude for the venue Double 20,15
redirect_id Redirect ID ID for the venue where to redirect this venue to Int 11

Read Item

This end-point is used to read a single item in this view. This returns all the data for the single item and the content of any linked items in the All Venue Propertys & Posts Views.

GET /index.php/api/v1/all_venues/item_id/${id}

Host: https://api.noster.info

Links

The All Venues view has the following links. To display the contents of a link, you need to specify the ID for the item whose links you want and the name of the link as item_id/id/link/link_name. See here for more information

Top Scoring

For more details on the Top Scoring end-point, please click here

Read List

This end-point is used to read a list of items in this view

POST /index.php/api/v1/top_scoring HTTP/1.1

Host: https://api.noster.info

Arguments

The Top Scoring end-point takes the following arguments in addition to the standard switches

Name Description Type Options
geo_center The latitude,longitude pair for the centre of the required geographic area Point
geo_min_distance The minimum distance from the centre in metres for which points are required Integer
geo_max_distance The maximum distance from the centre for which points are required Integer
chain_id The chain ID for the venue Integer
location_id The location id for the venue Integer
osm_data_set_id Data set from which this venue was imported Integer
item_id The ID of an item required when requesting a single item or a link Integer
limit The maximum number of items wanted in the response. The maximum allowed value is 100 Integer
format The format in which we want the data returned Enum json,xml
user_id The ID of the user accessing the API Call Integer
session_key The session key returned for the user when logging in Text

Fields

The following fields are displayed in the result of this api query

Field Name Title Description Type Length Options
name name Name of the venue String 256
id id Primary Key for the table Int 11
image image URL for an image associated with this pulse String 512
hopr_score hopr_score The GLOBAL Hoppiness value for this venue Int 11
categories categories List of text categories - probably temporary Textarea 65535
tags tags Tags for this venue Textarea 65535
phone phone The phone number for the venue String 256
website website The website URL for the venue Textarea 65535
facebook_page Facebook Page Facebook page for the venue String 256
twitter_handle Twitter Handle Facebook page for the venue String 256
instagram_page Instagram Page Reference to the youtube account for the venue String 255
pinterest_page pinterest_page Reference to the youtube account for the venue String 255
youtube_page youtube_page Reference to the youtube account for the venue String 255
tripadvisor_page tripadvisor_page Tripadvisor URL for the venue String 256
latitude latitude Latitude for the venue Double 20,15
longitude longitude Longitude for the venue Double 20,15
distance distance String
yelp_page yelp_page The primary value for the property Textarea 65535
deliveroo_page deliveroo_page The primary value for the property Textarea 65535
opentable_page opentable_page The primary value for the property Textarea 65535
golocal_page golocal_page The primary value for the property Textarea 65535
redirect_id Redirect ID ID for the venue where to redirect this venue to Int 11

Read Item

This end-point is used to read a single item in this view. This returns all the data for the single item and the content of any linked items in the Posts View.

GET /index.php/api/v1/top_scoring/item_id/${id}

Host: https://api.noster.info

Links

The Top Scoring view has the following links. To display the contents of a link, you need to specify the ID for the item whose links you want and the name of the link as item_id/id/link/link_name. See here for more information

Map

For more details on the Map end-point, please click here

Read List

This end-point is used to read a list of items in this view

POST /index.php/api/v1/map HTTP/1.1

Host: https://api.noster.info

Arguments

The Map end-point takes the following arguments in addition to the standard switches

Name Description Type Options
geo_bounds The bounding box of the area for which data is required (sw_lat,sw_long,ne_lat,ne_long) Boundary
chain_id The chain ID for the venue Integer
location_id The location id for the venue Integer
osm_data_set_id Data set from which this venue was imported Integer
item_id The ID of an item required when requesting a single item or a link Integer
limit The maximum number of items wanted in the response. The maximum allowed value is 100 Integer
format The format in which we want the data returned Enum json,xml
user_id The ID of the user accessing the API Call Integer
session_key The session key returned for the user when logging in Text

Fields

The following fields are displayed in the result of this api query

Field Name Title Description Type Length Options
name name Name of the venue String 256
id id Primary Key for the table Int 11
image image URL for an image associated with this pulse String 512
hopr_score hopr_score The GLOBAL Hoppiness value for this venue Int 11
categories categories List of text categories - probably temporary Textarea 65535
tags tags Tags for this venue Textarea 65535
phone phone The phone number for the venue String 256
website website The website URL for the venue Textarea 65535
pinterest_page pinterest_page Reference to the youtube account for the venue String 255
youtube_page youtube_page Reference to the youtube account for the venue String 255
tripadvisor_page tripadvisor_page Tripadvisor URL for the venue String 256
latitude latitude Latitude for the venue Double 20,15
longitude longitude Longitude for the venue Double 20,15
distance distance String
yelp_page yelp_page The primary value for the property Textarea 65535
deliveroo_page deliveroo_page The primary value for the property Textarea 65535
opentable_page opentable_page The primary value for the property Textarea 65535
golocal_page golocal_page The primary value for the property Textarea 65535
location Location Point location for venue Point

Read Item

This end-point is used to read a single item in this view. This returns all the data for the single item and the content of any linked items in the Posts View.

GET /index.php/api/v1/map/item_id/${id}

Host: https://api.noster.info

Links

The Map view has the following links. To display the contents of a link, you need to specify the ID for the item whose links you want and the name of the link as item_id/id/link/link_name. See here for more information

All Venue Propertys

Standard view for all items in the list

For more details on the All Venue Propertys end-point, please click here

Read List

This end-point is used to read a list of items in this view

POST /index.php/api/v1/all_venue_propertys HTTP/1.1

Host: https://api.noster.info

Arguments

The All Venue Propertys end-point takes the following arguments in addition to the standard switches

Name Description Type Options
property_name_id The property name for record Integer
venue_id Venue to which the record belongs Integer
item_id The ID of an item required when requesting a single item or a link Integer
limit The maximum number of items wanted in the response. The maximum allowed value is 1000 Integer
format The format in which we want the data returned Enum json,xml
user_id The ID of the user accessing the API Call Integer
session_key The session key returned for the user when logging in Text

Fields

The following fields are displayed in the result of this api query

Field Name Title Description Type Length Options
id ID Primary Key for the table Int 11
name Name The property name for record Int 200
value Value The primary value for the property Textarea 65535

Read Item

GET /index.php/api/v1/all_venue_propertys/item_id/${id}

Host: https://api.noster.info

Create Item

This end-point is used to create a new item in this view. This creates the item on the server and returns the created item.

POST /index.php/api/v1/all_venue_propertys HTTP/1.1

Host: https://api.noster.info

Update Item

This end-point is used to update an existing item in this view. This creates the item on the server and returns the created item.

POST /index.php/api/v1/all_venue_propertys/item_id/${id} HTTP/1.1 or

PUT /index.php/api/v1/all_venue_propertys/item_id/${id} HTTP/1.1

Host: https://api.noster.info

Delete Item

This end-point is used to delete and item in the view. Be very careful with this

DELETE /index.php/api/v1/all_venue_propertys/item_id/${id} HTTP/1.1 or

Host: https://api.noster.info

Berlin Top Bars

For more details on the Berlin Top Bars end-point, please click here

Read List

This end-point is used to read a list of items in this view

POST /index.php/api/v1/berlin_top_bars HTTP/1.1

Host: https://api.noster.info

Arguments

The Berlin Top Bars end-point takes the following arguments in addition to the standard switches

Name Description Type Options
chain_id The chain ID for the venue Integer
location_id The location id for the venue Integer
osm_data_set_id Data set from which this venue was imported Integer
item_id The ID of an item required when requesting a single item or a link Integer
limit The maximum number of items wanted in the response. The maximum allowed value is 100 Integer
format The format in which we want the data returned Enum json,xml
user_id The ID of the user accessing the API Call Integer
session_key The session key returned for the user when logging in Text

Fields

The following fields are displayed in the result of this api query

Field Name Title Description Type Length Options
name name Name of the venue String 256
id id Primary Key for the table Int 11
image image URL for an image associated with this pulse String 512
hopr_score hopr_score The GLOBAL Hoppiness value for this venue Int 11
categories categories List of text categories - probably temporary Textarea 65535
tripadvisor_page Tripadvisor Page Tripadvisor URL for the venue String 256
latitude latitude Latitude for the venue Double 20,15
longitude longitude Longitude for the venue Double 20,15
distance distance String
deliveroo_page deliveroo_page The primary value for the property Textarea 65535
opentable_page opentable_page The primary value for the property Textarea 65535
golocal_page golocal_page The primary value for the property Textarea 65535

Read Item

This end-point is used to read a single item in this view. This returns all the data for the single item and the content of any linked items in the Posts & Score Breakdown Views.

GET /index.php/api/v1/berlin_top_bars/item_id/${id}

Host: https://api.noster.info

Fields

These are extra fields shown when viewing a single item

Field Name Title Description Type Length Options
tags tags Tags for this venue Textarea 65535
website website The website URL for the venue Textarea 65535
phone phone The phone number for the venue String 256
facebook_page Facebook Page Facebook page for the venue String 256
twitter_handle Twitter Handle Facebook page for the venue String 256
instagram_page Instagram Page Reference to the youtube account for the venue String 255
pinterest_page Pinterest Page Reference to the youtube account for the venue String 255
youtube_page Youtube Page Reference to the youtube account for the venue String 255
yelp_page Yelp Page The primary value for the property Textarea 65535

Links

The Berlin Top Bars view has the following links. To display the contents of a link, you need to specify the ID for the item whose links you want and the name of the link as item_id/id/link/link_name. See here for more information

London Shopping

For more details on the London Shopping end-point, please click here

Read List

This end-point is used to read a list of items in this view

POST /index.php/api/v1/london_shopping HTTP/1.1

Host: https://api.noster.info

Arguments

The London Shopping end-point takes the following arguments in addition to the standard switches

Name Description Type Options
chain_id The chain ID for the venue Integer
location_id The location id for the venue Integer
osm_data_set_id Data set from which this venue was imported Integer
item_id The ID of an item required when requesting a single item or a link Integer
limit The maximum number of items wanted in the response. The maximum allowed value is 100 Integer
format The format in which we want the data returned Enum json,xml
user_id The ID of the user accessing the API Call Integer
session_key The session key returned for the user when logging in Text

Fields

The following fields are displayed in the result of this api query

Field Name Title Description Type Length Options
name name Name of the venue String 256
id id Primary Key for the table Int 11
image image URL for an image associated with this pulse String 512
hopr_score hopr_score The GLOBAL Hoppiness value for this venue Int 11
categories categories List of text categories - probably temporary Textarea 65535
tripadvisor_page Tripadvisor Page Tripadvisor URL for the venue String 256
latitude latitude Latitude for the venue Double 20,15
longitude longitude Longitude for the venue Double 20,15
distance distance String
deliveroo_page deliveroo_page The primary value for the property Textarea 65535
opentable_page opentable_page The primary value for the property Textarea 65535
golocal_page golocal_page The primary value for the property Textarea 65535

Read Item

This end-point is used to read a single item in this view. This returns all the data for the single item and the content of any linked items in the Posts & Score Breakdown Views.

GET /index.php/api/v1/london_shopping/item_id/${id}

Host: https://api.noster.info

Fields

These are extra fields shown when viewing a single item

Field Name Title Description Type Length Options
tags tags Tags for this venue Textarea 65535
website website The website URL for the venue Textarea 65535
phone phone The phone number for the venue String 256
facebook_page Facebook Page Facebook page for the venue String 256
twitter_handle Twitter Handle Facebook page for the venue String 256
instagram_page Instagram Page Reference to the youtube account for the venue String 255
pinterest_page Pinterest Page Reference to the youtube account for the venue String 255
youtube_page Youtube Page Reference to the youtube account for the venue String 255
yelp_page Yelp Page The primary value for the property Textarea 65535

Links

The London Shopping view has the following links. To display the contents of a link, you need to specify the ID for the item whose links you want and the name of the link as item_id/id/link/link_name. See here for more information

Paris Cafes

For more details on the Paris Cafes end-point, please click here

Read List

This end-point is used to read a list of items in this view

POST /index.php/api/v1/paris_cafes HTTP/1.1

Host: https://api.noster.info

Arguments

The Paris Cafes end-point takes the following arguments in addition to the standard switches

Name Description Type Options
chain_id The chain ID for the venue Integer
location_id The location id for the venue Integer
osm_data_set_id Data set from which this venue was imported Integer
item_id The ID of an item required when requesting a single item or a link Integer
limit The maximum number of items wanted in the response. The maximum allowed value is 100 Integer
format The format in which we want the data returned Enum json,xml
user_id The ID of the user accessing the API Call Integer
session_key The session key returned for the user when logging in Text

Fields

The following fields are displayed in the result of this api query

Field Name Title Description Type Length Options
name name Name of the venue String 256
id id Primary Key for the table Int 11
image image URL for an image associated with this pulse String 512
hopr_score hopr_score The GLOBAL Hoppiness value for this venue Int 11
categories categories List of text categories - probably temporary Textarea 65535
tripadvisor_page Tripadvisor Page Tripadvisor URL for the venue String 256
latitude latitude Latitude for the venue Double 20,15
longitude longitude Longitude for the venue Double 20,15
distance distance String
deliveroo_page deliveroo_page The primary value for the property Textarea 65535
opentable_page opentable_page The primary value for the property Textarea 65535
golocal_page golocal_page The primary value for the property Textarea 65535

Read Item

This end-point is used to read a single item in this view. This returns all the data for the single item and the content of any linked items in the Posts & Score Breakdown Views.

GET /index.php/api/v1/paris_cafes/item_id/${id}

Host: https://api.noster.info

Fields

These are extra fields shown when viewing a single item

Field Name Title Description Type Length Options
tags tags Tags for this venue Textarea 65535
website website The website URL for the venue Textarea 65535
phone phone The phone number for the venue String 256
facebook_page Facebook Page Facebook page for the venue String 256
twitter_handle Twitter Handle Facebook page for the venue String 256
instagram_page Instagram Page Reference to the youtube account for the venue String 255
pinterest_page Pinterest Page Reference to the youtube account for the venue String 255
youtube_page Youtube Page Reference to the youtube account for the venue String 255
yelp_page Yelp Page The primary value for the property Textarea 65535

Links

The Paris Cafes view has the following links. To display the contents of a link, you need to specify the ID for the item whose links you want and the name of the link as item_id/id/link/link_name. See here for more information

San Francisco Restaurants

For more details on the San Francisco Restaurants end-point, please click here

Read List

This end-point is used to read a list of items in this view

POST /index.php/api/v1/san_francisco_restaurants HTTP/1.1

Host: https://api.noster.info

Arguments

The San Francisco Restaurants end-point takes the following arguments in addition to the standard switches

Name Description Type Options
chain_id The chain ID for the venue Integer
location_id The location id for the venue Integer
osm_data_set_id Data set from which this venue was imported Integer
item_id The ID of an item required when requesting a single item or a link Integer
limit The maximum number of items wanted in the response. The maximum allowed value is 100 Integer
format The format in which we want the data returned Enum json,xml
user_id The ID of the user accessing the API Call Integer
session_key The session key returned for the user when logging in Text

Fields

The following fields are displayed in the result of this api query

Field Name Title Description Type Length Options
name name Name of the venue String 256
id id Primary Key for the table Int 11
image image URL for an image associated with this pulse String 512
hopr_score hopr_score The GLOBAL Hoppiness value for this venue Int 11
categories categories List of text categories - probably temporary Textarea 65535
tripadvisor_page Tripadvisor Page Tripadvisor URL for the venue String 256
latitude latitude Latitude for the venue Double 20,15
longitude longitude Longitude for the venue Double 20,15
distance distance String
deliveroo_page deliveroo_page The primary value for the property Textarea 65535
opentable_page opentable_page The primary value for the property Textarea 65535
golocal_page golocal_page The primary value for the property Textarea 65535

Read Item

This end-point is used to read a single item in this view. This returns all the data for the single item and the content of any linked items in the Posts & Score Breakdown Views.

GET /index.php/api/v1/san_francisco_restaurants/item_id/${id}

Host: https://api.noster.info

Fields

These are extra fields shown when viewing a single item

Field Name Title Description Type Length Options
tags tags Tags for this venue Textarea 65535
website website The website URL for the venue Textarea 65535
phone phone The phone number for the venue String 256
facebook_page Facebook Page Facebook page for the venue String 256
twitter_handle Twitter Handle Facebook page for the venue String 256
instagram_page Instagram Page Reference to the youtube account for the venue String 255
pinterest_page Pinterest Page Reference to the youtube account for the venue String 255
youtube_page Youtube Page Reference to the youtube account for the venue String 255
yelp_page Yelp Page The primary value for the property Textarea 65535

Links

The San Francisco Restaurants view has the following links. To display the contents of a link, you need to specify the ID for the item whose links you want and the name of the link as item_id/id/link/link_name. See here for more information

Venues

For more details on the Venues end-point, please click here

Read List

This end-point is used to read a list of items in this view

POST /index.php/api/v1/venues HTTP/1.1

Host: https://api.noster.info

Arguments

The Venues end-point takes the following arguments in addition to the standard switches

Name Description Type Options
chain_id The chain ID for the venue Integer
location_id The location id for the venue Integer
osm_data_set_id Data set from which this venue was imported Integer
item_id The ID of an item required when requesting a single item or a link Integer
limit The maximum number of items wanted in the response. The maximum allowed value is 50 Integer
format The format in which we want the data returned Enum json,xml
user_id The ID of the user accessing the API Call Integer
session_key The session key returned for the user when logging in Text

Fields

The following fields are displayed in the result of this api query

Field Name Title Description Type Length Options
distance distance String
name name Name of the venue String 256
image image URL for an image associated with this pulse String 512
instagram_page Instagram Page Reference to the youtube account for the venue String 255
facebook_id facebook_id Facebook id for the venue String 256
facebook_page facebook_page Facebook page for the venue String 256
twitter_handle Twitter Handle Facebook page for the venue String 256
yelp_page yelp_page The primary value for the property Textarea 65535
deliveroo_page deliveroo_page The primary value for the property Textarea 65535
opentable_page opentable_page The primary value for the property Textarea 65535
golocal_page golocal_page The primary value for the property Textarea 65535
id id Primary Key for the table Int 11
hopr_score hopr_score The GLOBAL Hoppiness value for this venue Int 11
categories categories List of text categories - probably temporary Textarea 65535
tags tags Tags for this venue Textarea 65535
phone phone The phone number for the venue String 256
website website The website URL for the venue Textarea 65535
pinterest_page pinterest_page Reference to the youtube account for the venue String 255
youtube_page youtube_page Reference to the youtube account for the venue String 255
tripadvisor_page tripadvisor_page Tripadvisor URL for the venue String 256
latitude latitude Latitude for the venue Double 20,15
longitude longitude Longitude for the venue Double 20,15

Read Item

This end-point is used to read a single item in this view. This returns all the data for the single item and the content of any linked items in the All Venue Propertys & Posts Views.

GET /index.php/api/v1/venues/item_id/${id}

Host: https://api.noster.info

Links

The Venues view has the following links. To display the contents of a link, you need to specify the ID for the item whose links you want and the name of the link as item_id/id/link/link_name. See here for more information