Developer Reference

Fing Local API

A free, locally-published HTTP API for integrating Fing monitoring agents — Fing Desktop, Fing Agent, and Fingbox — into custom workflows. Query real-time device presence, connection history, and network status without relying on external services.

Version 1.1.0

Proprietary license

support@fing.com

fing.com ↗

Devices

GET /devices List all network devices

Description

Returns all devices discovered on the local network, including current state (UP/DOWN), IP and MAC addresses, device type, manufacturer, and presence timestamps.

Authorization ApiKeyAuth — query param auth

Request URL

GET http://localhost:49090/1/devices?auth={api_key}

Responses

Code	Description
200	Successful — returns a `DevicesResult` object.
400	Invalid input.
401	Unauthorized — invalid or missing API key.
503	Service error — agent not running or unavailable.

Response schema — 200

networkIdreqstringNetwork identifier. e.g. wifi-12345812839223

devicesreqDevice[]Array of device objects.

↳ macreqstringMAC address. e.g. 00:11:22:33:44:55

↳ ipreqstring[]One or more IP addresses.

↳ statereqstringUP or DOWN

↳ namestringHuman-readable device name.

↳ typestringDevice category. e.g. STREAMING_DONGLE

↳ makestringDevice brand / manufacturer.

↳ modelstringDevice model name.

↳ contactIdstring (uuid)Reference to the Contact that owns this device.

↳ first_seendate-timeISO 8601 — when the device was first discovered.

↳ last_changeddate-timeISO 8601 — last state change.

Response sample — 200

{
  "networkId": "wifi-12345812839223",
  "devices": [
    {
      "mac":          "00:11:22:33:44:55",
      "ip":           ["192.168.0.1"],
      "state":        "UP",
      "name":         "Bedroom Chromecast",
      "type":         "STREAMING_DONGLE",
      "make":         "Google",
      "model":        "Chromecast",
      "contactId":    "67363e09-5ad6-40d0-883f-3e17254eec7a",
      "first_seen":   "2020-04-24T12:54:21.634Z",
      "last_changed": "2020-06-11T12:01:23.164Z"
    }
  ]
}

People

GET /people List contacts and their presence

Fing Desktop only. This endpoint is exclusively available when running a Fing Desktop monitoring agent. It is not supported by Fing Agent or Fingbox. Calls from unsupported agents will result in a service error.

Description

Returns the list of contacts defined for this network and their current online/offline presence state, derived from the presence devices assigned to each contact.

Authorization ApiKeyAuth — query param auth

Request URL

GET http://localhost:49090/1/people?auth={api_key}

Responses

Code	Description
200	Successful — returns a `PeopleResult` object.
400	Invalid input.
401	Unauthorized — invalid or missing API key.
503	Service error — agent not running, unsupported agent, or unavailable.

Response schema — 200

networkIdreqstringIdentifier of the current network.

lastChangeTimereqdate-timeISO 8601 — last contacts update.

peoplereqContact[]Array of contact objects.

↳ stateChangeTimereqdate-timeISO 8601 — last online/offline change for this contact.

↳ contactInforeqobjectHuman-readable contact details (name, picture, type).

↳ currentStatestringONLINE or OFFLINE. Absent if no presence device assigned.

↳ presenceDeviceDetailsobjectDetails of the presence device used to determine state.

Response sample — 200

{
  "networkId":      "wifi-12345812839223",
  "lastChangeTime":  "2020-04-24T12:54:21.634Z",
  "people": [
    {
      "stateChangeTime":      "2020-04-24T12:54:21.634Z",
      "contactInfo":          {
        "contactId":   "67363e09-5ad6-40d0-883f-3e17254eec7a",
        "displayName": "Elenore",
        "contactType": "COLLEAGUE"
      },
      "currentState":          "ONLINE",
      "presenceDeviceDetails": {}
    }
  ]
}

Security — API Key Auth

All endpoints require an API key passed as the auth query parameter.

GET http://localhost:49090/1/devices?auth=YOUR_API_KEY

Find or generate your API key in the Fing Desktop application settings. Keep it confidential — it grants access to your local network's device data.