tfl-ts
Version:
🚇 Fully-typed TypeScript client for Transport for London (TfL) API • Zero dependencies • Auto-generated types • Real-time arrivals • Journey planning • Universal compatibility
213 lines (212 loc) • 9.81 kB
TypeScript
export declare const PLACE_DATA: {
readonly section: "Place";
readonly endpoints: readonly [{
readonly path: "/Place/Address/Streets/{Postcode}";
readonly method: "GET";
readonly summary: "Gets the set of streets associated with a post code.";
readonly parameters: readonly [{
readonly name: "postcode";
readonly type: "string";
readonly required: true;
}, {
readonly name: "postcodeInput.postcode";
readonly type: "string";
readonly required: false;
}];
readonly returnType: "Object";
readonly deprecated: false;
readonly tags: readonly ["Place"];
}, {
readonly path: "/Place/Type/{types}";
readonly method: "GET";
readonly summary: "Gets all places of a given type";
readonly parameters: readonly [{
readonly name: "types";
readonly type: "any";
readonly required: true;
readonly description: "A comma-separated list of the types to return. Max. approx 12 types.\r\n A valid list of place types can be obtained from the /Place/Meta/placeTypes endpoint.";
}, {
readonly name: "activeOnly";
readonly type: "boolean";
readonly required: false;
readonly description: "An optional parameter to limit the results to active records only (Currently only the 'VariableMessageSign' place type is supported)";
}];
readonly returnType: "Place[]";
readonly deprecated: false;
readonly tags: readonly ["Place"];
}, {
readonly path: "/Place/{id}";
readonly method: "GET";
readonly summary: "Gets the place with the given id.";
readonly parameters: readonly [{
readonly name: "id";
readonly type: "string";
readonly required: true;
readonly description: "The id of the place, you can use the /Place/Types/{types} endpoint to get a list of places for a given type including their ids";
}, {
readonly name: "includeChildren";
readonly type: "boolean";
readonly required: false;
readonly description: "Defaults to false. If true child places e.g. individual charging stations at a charge point while be included, otherwise just the URLs of any child places will be returned";
}];
readonly returnType: "Place[]";
readonly deprecated: false;
readonly tags: readonly ["Place"];
}, {
readonly path: "/Place";
readonly method: "GET";
readonly summary: "Gets the places that lie within a geographic region. The geographic region of interest can either be specified\r\n by using a lat/lon geo-point and a radius in metres to return places within the locus defined by the lat/lon of\r\n its centre or alternatively, by the use of a bounding box defined by the lat/lon of its north-west and south-east corners.\r\n Optionally filters on type and can strip properties for a smaller payload.";
readonly parameters: readonly [{
readonly name: "radius";
readonly type: "number";
readonly required: false;
readonly description: "The radius of the bounding circle in metres when only lat/lon are specified.";
}, {
readonly name: "categories";
readonly type: "any";
readonly required: false;
readonly description: "An optional list of comma separated property categories to return in the Place's property bag. If null or empty, all categories of property are returned. Pass the keyword \"none\" to return no properties (a valid list of categories can be obtained from the /Place/Meta/categories endpoint)";
}, {
readonly name: "includeChildren";
readonly type: "boolean";
readonly required: false;
readonly description: "Defaults to false. If true child places e.g. individual charging stations at a charge point while be included, otherwise just the URLs of any child places will be returned";
}, {
readonly name: "type";
readonly type: "any";
readonly required: false;
readonly description: "Place types to filter on, or null to return all types";
}, {
readonly name: "activeOnly";
readonly type: "boolean";
readonly required: false;
readonly description: "An optional parameter to limit the results to active records only (Currently only the 'VariableMessageSign' place type is supported)";
}, {
readonly name: "numberOfPlacesToReturn";
readonly type: "number";
readonly required: false;
readonly description: "If specified, limits the number of returned places equal to the given value";
}, {
readonly name: "placeGeo.swLat";
readonly type: "number";
readonly required: false;
}, {
readonly name: "placeGeo.swLon";
readonly type: "number";
readonly required: false;
}, {
readonly name: "placeGeo.neLat";
readonly type: "number";
readonly required: false;
}, {
readonly name: "placeGeo.neLon";
readonly type: "number";
readonly required: false;
}, {
readonly name: "placeGeo.lat";
readonly type: "number";
readonly required: false;
}, {
readonly name: "placeGeo.lon";
readonly type: "number";
readonly required: false;
}];
readonly returnType: "StopPoint[]";
readonly deprecated: false;
readonly tags: readonly ["Place"];
}, {
readonly path: "/Place/{type}/At/{Lat}/{Lon}";
readonly method: "GET";
readonly summary: "Gets any places of the given type whose geography intersects the given latitude and longitude. In practice this means the Place\r\n must be polygonal e.g. a BoroughBoundary.";
readonly parameters: readonly [{
readonly name: "type";
readonly type: "any";
readonly required: true;
readonly description: "The place type (a valid list of place types can be obtained from the /Place/Meta/placeTypes endpoint)";
}, {
readonly name: "lat";
readonly type: "string";
readonly required: true;
}, {
readonly name: "lon";
readonly type: "string";
readonly required: true;
}, {
readonly name: "location.lat";
readonly type: "number";
readonly required: true;
}, {
readonly name: "location.lon";
readonly type: "number";
readonly required: true;
}];
readonly returnType: "Object";
readonly deprecated: false;
readonly tags: readonly ["Place"];
}, {
readonly path: "/Place/{type}/overlay/{z}/{Lat}/{Lon}/{width}/{height}";
readonly method: "GET";
readonly summary: "Gets the place overlay for a given set of co-ordinates and a given width/height.";
readonly parameters: readonly [{
readonly name: "z";
readonly type: "number";
readonly required: true;
readonly description: "The zoom level";
}, {
readonly name: "type";
readonly type: "any";
readonly required: true;
readonly description: "The place type (a valid list of place types can be obtained from the /Place/Meta/placeTypes endpoint)";
}, {
readonly name: "width";
readonly type: "number";
readonly required: true;
readonly description: "The width of the requested overlay.";
}, {
readonly name: "height";
readonly type: "number";
readonly required: true;
readonly description: "The height of the requested overlay.";
}, {
readonly name: "lat";
readonly type: "string";
readonly required: true;
}, {
readonly name: "lon";
readonly type: "string";
readonly required: true;
}, {
readonly name: "location.lat";
readonly type: "number";
readonly required: true;
}, {
readonly name: "location.lon";
readonly type: "number";
readonly required: true;
}];
readonly returnType: "Object";
readonly deprecated: false;
readonly tags: readonly ["Place"];
}, {
readonly path: "/Place/Search";
readonly method: "GET";
readonly summary: "Gets all places that matches the given query";
readonly parameters: readonly [{
readonly name: "name";
readonly type: "string";
readonly required: true;
readonly description: "The name of the place, you can use the /Place/Types/{types} endpoint to get a list of places for a given type including their names.";
}, {
readonly name: "types";
readonly type: "any";
readonly required: false;
readonly description: "A comma-separated list of the types to return. Max. approx 12 types.";
}];
readonly returnType: "Place[]";
readonly deprecated: false;
readonly tags: readonly ["Place"];
}];
readonly totalEndpoints: 7;
readonly generatedAt: "2025-07-10T01:28:59.105Z";
};
export type PLACE_DATAType = typeof PLACE_DATA;