The table below outlines how different aspects of the Address Lookup API operate, and how each can be used.
|
Endpoint |
How it works |
What it can be used for |
|---|---|---|
|
/addresses |
Search an address string to find an FSL or TUI |
Find an FSL or TUI from searching an address string. The FSL (but not TUI) can be used to search the Fibre Broadband Availability API. |
|
/addresses/{ID} |
Find information on an address by searching with an FSL or TUI |
With this endpoint you can find out more information on the address. A TUI can also be used to discover the FSL. |
|
/version |
Returns the application version information |
Used to retrieve version information or to ensure the application is running. |