| API Call | https://api.taxifarefinder.com/entity? key=<TFF API KEY> &location=42.356261,-71.065334 |
| Output | { "status": "OK", "name": "Boston", "full_name": "Boston, MA", "handle": "Boston", "locale": "en_US", "distance": 1416 } |
| key | Valid TFF API key | key |
| location | lat/lng of location. If city/state/country are not provided, or an entity cannot be found using those data, the nearest entity to this lat/lng will be returned. | <float>,<float> |
| callback | If provided, wrap JSON object in call to this javascript function (JSONP) | function name |
| max_distance | Maximum distance from entity in meters. Defaults to 80467 meters (50 miles) | integer |
| status | status code |
| name | Short name for entity |
| full_name | Long name for entity |
| handle | TFF handle for this entity |
| locale | Entity's locale |
| distance | Meters from given location to entity |
| how_found | "geocode" or "nearest", depending on what method TFF was able to use to find the entity. |
| API Call | https://api.taxifarefinder.com/fare? key=<TFF API KEY> &entity_handle=Boston &origin=42.368025,-71.022155 &destination=42.362571,-71.055543 |
| Output | { "status": "OK", "total_fare": 27.11, "initial_fare": 2.6, "metered_fare": 13.47, "tip_amount": 3.54, "tip_percentage": 15, "locale": "en_US", "rate_area": "Boston, MA", "flat_rates": [ ], "extra_charges": [ { "charge": 5.25, "description": "Harbor Tunnel Tolls" }, { "charge": 2.25, "description": "Logan Airport Fee" } ] } |
| key | Valid TFF API key | key |
| origin | Origin lat/lng | <float>,<float> |
| destination | Destination lat/lng | <float>,<float> |
| callback | If provided, wrap JSON object in call to this javascript function (JSONP) | function name |
| entity_handle | Valid TFF entity handle. In cases where the entity handle is known, this parameter should be supplied in order to provide for faster API response | entity handle |
| traffic | Traffic level. Defaults to medium | light|medium|heavy |
| max_distance | Maximum distance from entity in meters. Defaults to 80467 meters (50 miles). Does not apply if entity_handle is specified. | integer |
| status | status code |
| distance | Distance in meters of the route used to calculate this fare. |
| duration | Duration in seconds of the route used to calculate this fare. |
| total_fare | Total fare, including initial fare, metered fare, and tip. |
| initial_fare | Flag drop charge, or charge for first portion of trip. |
| metered_fare | Additional metered fare based upon the length and duration of the trip. |
| flat_rates | Array of objects, each describing a flat rate that is applicable to this trip. Each object contains the following properties: |
| charge | Amount of charge. |
| description | Explanation of charge. |
| extra_charges | Array of objects, each describing an extra charges that is applicable to this trip. Each object contains the following properties: |
| charge | Amount of charge. |
| description | Explanation of charge. |
| tip_amount | Tip to add in addition to initial_fare + metered_fare. |
| tip_percentage | Tip percentage that was used, customary to this region. |
| locale | Locale for entity used in fare calculation. |
| currency | Information about the local currency for this entity |
| int_symbol | International currency symbol (USD) |
| rate_area | Name of municipality used for the rates. May differ from the entity passed in to this call, for instance if the entity is part of a larger metropolitan area which governs taxi rates. |
| API Call | https://api.taxifarefinder.com/businesses? key=<TFF API KEY> &entity_handle=Boston |
| Output | { "status": "OK", "businesses": [ { "name": "CabCo1", "phone": "xxx-xxx-xxxx", "type": "taxi" }, { "name": "CabCo2", "phone": "xxx-xxx-xxxx", "type": "taxi" } ] } |
| key | Valid TFF API key | key |
| entity_handle | entity handle | entity handle |
| callback | If provided, wrap JSON object in call to this javascript function (JSONP) | function name |
| status | status code |
| businesses | Array of objects, each describing a taxi company local to this entity. Each object contains the following properties: |
| name | Name of business |
| phone | Dispatch phone number of business |
| type | Business type: "taxi" or "limo" |
| OK | Result found ok |
| NO_MATCHING_ENTITY | No entity found within given constraints |
| UNKNOWN_ENTITY | No entity with given entity handle found |
| UNSUPPORTED_ENTITY | The entity handle provided is not a supported entity for the TFF API |
| MISSING_PARAMETER | A required parameter is missing |
| UNKNOWN_PARAMETER | A provided parameter is not valid for this API call |
| WRONG_PARAMETER_TYPE | A given parameter value is of the wrong type |
| INVALID_KEY | API key provided is invalid |
| INVALID_CALLBACK | An invalid JavaScript function name was provided for the JSONP callback |
| REQUEST_LIMIT_REACHED | Daily request limit for this API key has been reached |
| REQUEST_TIMED_OUT | The request to the server took too long, try again |
| QUERY_RATE_LIMIT_EXCEEDED | Query rate has been exceeded, throttle queries at 10 or fewer per second |
| NO_ROUTE_FOUND | No route could be found between origin and destination |
| NO_NEARBY_ENTITY | There is not an entity near the origin location |
| ERROR | Unspecified error occurred |