Connect 3rd Party Apps to Fing (Local API)

A local API is an API that runs only on your computer or home network without sending anything to the cloud.  The Local API feature allows you to connect third party apps to Fing to share information from those apps.  Examples of third party apps include Home Assistant and smart home apps. You can link these apps to Fing to automate tasks and get information from Fing scans.

Fing can run a local HTTP API. A local HTTP API detects the presence of devices and provides information about these devices. This information can be used for IoT integrations.

Configure Local API from Fing Web App

1. To configure a Local API from Fing Web App, select Manage > Settings from the top level menu on the Fing Dashboard. The Agent Settings window is displayed.
2. Select Local API to display the Local API settings.Select Enable if not already selected.
3.  Type the selected Port and API Key in the respective fields or continue with the default settings. For some applications, for example, Home Assistant, you need to match the port and API number on Fing's Local API to the Home Assistant API settings. If you need to change the API and port number, enter a port number from 1 - 65535 in the 'Port' field. Enter an API key  (8 - 64 characters with no spaces.)
4. Click Save to finish.

Configure Local API from Fing Desktop

1. From Overview, click your username at the bottom left of the dashboard window.
2. Select Preferences from the drop-down menu to display the App Preferences window.
3. Click the Local API tab at the top of the window.
4. Turn on the on/off switch beside Enable local API.
5. Type the selected Port and API Key in the respective fields or continue with the default settings.  For some applications, for example, Home Assistant, you need to match the port and API number on Fing's Local API to the Home Assitant API settings.  If you need to change the API and Port number, enter a Port number from 1 - 65535 in the Port field, and enter an API key  (8 - 64 characters with no spaces.)
6. Click Save to finish.

Configure Local API from Fing Mobile

1. Open Fing App and sign in.
2. From the Home window, select the Hamburger icon (ellipses) at the top right screen, and then select the Agent name from the list of Monitored networks.
3. Tap on the Gear icon in the top-right corner to display the Agent Settings window.
4. Scroll down and enable the "Local API" setting.
5. Enter the Port and API key you want to use, and then Click Save.  For some applications, for example, Home Assistant, you need to match the port and API number on Fing's Local API to the Home Assitant API settings.   If you need to change the API and Port number, enter a Port number from 1 - 65535 in the Port field.   Enter an API key  (8 - 64 characters with no spaces.)
6. Click Save to finish.

Need help?

Click the Submit a request button at the top right of the page.