diff --git a/README.md b/README.md index 9a2bacc..e916d37 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,20 @@ Powered by Node.JS and using the ldbs-json module, the OwlBoard API provides up Whilst the application is open source, the webservice (owlboard.fb-infra.uk) is not openly available. National Rail Enquiries have limits on API access so to use this software yourself, you'll need to run your own instance after obtaining your own API key. -## Default Settings - -webPort: 8460 - ## WebApp Colours: - - To be updated \ No newline at end of file + - To be updated + +## API Endpoints: + - /api: + - /test: + - GET: Check your connection with the server + - POST: Check your auth key + - Request Body JSON: `{"auth":""}` + - Returns JSON: `{"auth":"true/false"}` + + - /list: + - GET: Get list of stations + - Returns JSON: `{"STATION NAME":{"CRS":"code","TIPLOC":"code"}}` + + - /ldb: \ No newline at end of file