tfl-unified-api

tfl-unified-api-nodejs

An abstraction layer for accessing the TfL Unified API

Currently only some of th line api functions have been added

install

npm install tfl-unified-api --save

usage

To use this package you can either import an individual api or import all of the apis into your application. For an individual module you can use:

import Line from 'TfLUnified/api';

or

const { Line } = require('tfl-unified-api);

If you want to import all of the modules just use:

const TfL = require('tfl-unified-api');

Once imported you need to create a client instance where wou would provide an api key for it to use:

const { Line } = require('tfl-unified-api');

const client = new Line({
  app_key: '{your app_key from https://api.tfl.gov.uk}',
  app_id: '{your app_id from https://api.tfl.gov.uk}'
});

The available APIs are listed in the API Docs Page as all of the static members of the module. If however you have imported all of the apis into a single object then you will have full access to all methods as if you had imported only a single one.

api documentation

The documentation can be found on the API Docs Page