API Documentation - user.getMetroList

Welcome, Guest Sign In | Sign Up | Help

Upcoming

Upcoming API Documentation

Currently, the use of these APIs are restricted to non-commercial use only. If you'd like to use it for commercial purposes, please contact us first.

user.getMetroList [HTTP GET]

Retrieve a list of metros for a particular user.

Arguments

api_key (Required)
Your API application key. If you don't have one, create one.

token (Required)
An authentication token. (What's this?)

Example Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<rsp stat="ok" version="1.0">
  <metro id="1" name="Los Angeles" code="la" state_id="5"
    state_name="California" state_code="ca" country_id="1"
    country_name="United States" country_code="us"/> 
  <metro id="19" name="Orange County" code="oc" state_id="5"
    state_name="California" state_code="ca" country_id="1"
    country_name="United States" country_code="us"/> 
</rsp>

JSON

{
   "rsp":{
      "stat":"ok",
      "version":1,
      "metro":[
         {
            "id":246,
            "name":"Palo Alto",
            "code":"pa",
            "state_id":5,
            "state_name":"California",
            "state_code":"ca",
            "country_id":1,
            "country_name":"United States",
            "country_code":"us"
         },
         {
            "id":2,
            "name":"San Francisco",
            "code":"sf",
            "state_id":5,
            "state_name":"California",
            "state_code":"ca",
            "country_id":1,
            "country_name":"United States",
            "country_code":"us"
         },
         {
            "id":45,
            "name":"San Francisco Bay Area",
            "code":"sfba",
            "state_id":5,
            "state_name":"California",
            "state_code":"ca",
            "country_id":1,
            "country_name":"United States",
            "country_code":"us"
         },
         {
            "id":3,
            "name":"San Jose",
            "code":"sj",
            "state_id":5,
            "state_name":"California",
            "state_code":"ca",
            "country_id":1,
            "country_name":"United States",
            "country_code":"us"
         },
         {
            "id":923,
            "name":"Silicon Valley",
            "code":"silicon",
            "state_id":5,
            "state_name":"California",
            "state_code":"ca",
            "country_id":1,
            "country_name":"United States",
            "country_code":"us"
         }
      ]
   }
}

Error Codes

403 Not Authorized:

Missing valid authentication parameters - Please pass an authentication token to the method.
Invalid authentication parameters - either that token was not found, or it may be deactivated. Please contact us for support.

404 Not Found:

Missing valid api_key - Please create an API key using the above link.
Your api_key is inactive or not found - Please contact us for support.
Missing valid state_id parameter - Your state_id may be improperly formatted or non-numeric. Only numeric state_id's are allowed.

Tools: Upcoming Badges for Your Blog/Website | Invite Friends | Groups | Developers API
Help: News Blog | Community Guidelines | FAQ | Contact Us | Suggestion Board | About Us