TCS API Documentation

Introduction

The TCSHUB API provides access to the current licensing status of your drivers and vehicles as reported by the New York City Taxi and Limousine Commission.

Access is available to paid subscribers of the TCS App with a separate subscription to the API. To subscribe to the API service, sign in and click here for more information.

Usage

All calls require a key parameter with your API key.. See above for information on how to obtain your API key.

Important notes about the API:

  • Use GET method for all calls
  • Response format is JSON only
  • Status 200 is returned for successful calls, even those that return error status

For example, to get information on a specific driver:

https://app.tcshub.com/api/driver/XXXX?key=YYYY

where XXXX is the TLC license number of the driver and YYYY is your API key

Example successful response:

{
	licenseNumber: "12345678",
	licenseeName: "John Doe",
	licenseExpirationDate: "2016-10-05T04:00:00.000Z",
	licenseType: "For-Hire-Vehicle Driver",
	dmvStatus: "CURRENT",
	dmvStatusChecked: "2014-11-05T04:00:00.000Z",
	tlcStatus: "CURRENT",
	tlcStatusChecked: "2014-11-05T04:00:00.000Z"
}

Example error response:

{
	error: "Driver not found"
}

Driver Information

To get a list of all drivers in your account:

https://app.tcshub.com/api/drivers

To get information on an specific driver, append the license number as the second URI parameter:

https://app.tcshub.com/api/driver/XXXX

Description of returned fields:

  • licenseNumber - TLC license number of the driver
  • licenseeName - Full name of the licensee on file with the TLC
  • licenseExpirationDate - Expiration date of the TLC license
  • licenseType - Type of license: FHV, Medallion
  • tlcStatus - Status of driver's TLC license: CURRENT or NOT CURRENT (NOT CURRENT indicates the license is suspended or revoked)
  • tlcStatusChecked - Timestamp indicating when the last status check was performed by our system
  • dmvStatus - Status of driver's DMV license: CURRENT or NOT CURRENT (NOT CURRENT indicates the license is suspended or revoked)
  • dmvStatusChecked - Timestamp indicating when the last status check was performed by our system

Vehicle Information

To get a list of all vehicles in your account:

https://app.tcshub.com/api/vehicles

To get information on an specific vehicle, append the license number as the second URI parameter:

https://app.tcshub.com/api/vehicle/XXXX

Description of returned fields:

  • licenseNumber - TLC license number of the vehicle
  • licenseeName - Full name of the licensee on file with the TLC
  • vin - Vehicle Identification Number
  • modelYear - Model year of the vehicle
  • licenseExpirationDate - Expiration date of the TLC license
  • tlcStatus - Status of vehicle's TLC license: CURRENT or NOT CURRENT (NOT CURRENT indicates the license is suspended or revoked)
  • tlcStatusChecked - Timestamp indicating when the last status check was performed by our system
  • dmvStatus - Status of vehicle registration with DMV: CURRENT or NOT CURRENT (NOT CURRENT indicates the vehicle registration is suspended or revoked)
  • dmvStatusChecked - Timestamp indicating when the last status check was performed by our system