blinkpy Python Library

You can programmatically arm or disarm your Blink network to start or stop recording and reporting motion events.

Note on Asynchronous Execution: Calling the /arm or /disarm endpoints does not mean the command has completed. The response will contain a command/request ID. You must capture this ID and poll the Command Status endpoint to verify when the operation has successfully finished.

# Arm the network
curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --data-binary --compressed https://rest.prod.immedia-semi.com/network/*network_id*/arm

# Disarm the network
curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --data-binary --compressed https://rest.prod.immedia-semi.com/network/*network_id*/disarm

You can manage credentials using JSON files to avoid repeated logins.

To load credentials: Use blinkpy.helpers.util.json_load to load a JSON file containing at least username and password into an Auth object.

To save credentials: Use await blink.save("<File location>"). This saves authentication tokens and unique IDs to streamline future sessions.

import asyncio
from aiohttp import ClientSession
from blinkpy.blinkpy import Blink
from blinkpy.auth import Auth
from blinkpy.helpers.util import json_load

async def start():
    blink = Blink()
    auth = Auth(await json_load("<File Location>"))
    blink.auth = auth
    try:
        await blink.start()
    except BlinkTwoFARequiredError:
        await blink.prompt_2fa()
    return blink

blink = asyncio.run(start())

# To save credentials for later:
# await blink.save("<File location>")

The simplest way to use blinkpy is to call await Blink.start(). This method will interactively prompt you for your Blink username and password. If Two-Factor Authentication (2FA) is enabled, you will be prompted to enter the PIN sent to your email address.

Note: HTTP requests are throttled internally using the Blink.refresh_rate variable, which defaults to 30 seconds. It is recommended not to make API calls faster than every 60 seconds to avoid overwhelming Blink's servers.

import asyncio
from aiohttp import ClientSession
from blinkpy.blinkpy import Blink

async def start():
    blink = Blink(session=ClientSession())
    try:
        await blink.start()
    except BlinkTwoFARequiredError:
        await blink.prompt_2fa()
    return blink

blink = asyncio.run(start())

Install the stable version of blinkpy using pip:

pip install blinkpy

To install the current development version from source:

$ cd ~
$ git clone https://github.com/fronzbot/blinkpy.git
$ cd blinkpy
$ pip install .

The BlinkSyncModule maintains a dictionary of cameras where keys are camera names and values are instances of camera classes (e.g., BlinkCamera, BlinkCameraMini, or BlinkDoorbell).

When update_cameras() or refresh() is called, the module:

1. Queries the server for camera configurations.
2. Maps the configuration type to the appropriate class.
3. Instantiates the camera object and calls its .update() method to sync its internal state with the server.

To access video clips stored on a Sync Module's local storage, follow this workflow:

1. Request a manifest update: Call request_local_storage_manifest to tell the Sync Module to generate a new list of clips.
2. Wait for completion: The manifest request returns a response that must be processed.
3. Get the manifest: Use get_local_storage_manifest with the manifest_request_id returned from the previous step to retrieve the list of available clips.
4. Prepare a clip for download: Use request_local_storage_clip with the manifest_id and the specific clip_id to get the download URL.

The library implements the full OAuth 2.0 flow required for Blink authentication. The process follows these steps:

1. oauth_authorize_request: Initiates the request to the authorization URL using a code_challenge (PKCE).
2. oauth_get_signin_page: Fetches the sign-in page to extract the necessary csrf_token.
3. oauth_signin: Submits credentials. This may return SUCCESS or 2FA_REQUIRED.
4. oauth_verify_2fa: If 2FA is required, use this to submit the user's code.
5. oauth_get_authorization_code: Retrieves the authorization code from the redirect URL.
6. oauth_exchange_code_for_token: Exchanges the code and code_verifier for access and refresh tokens.
7. oauth_refresh_token: Uses a refresh token to obtain a new access token when the current one expires.

To interact with the Blink API, you must first authenticate to obtain an authtoken. This token must be included in the TOKEN_AUTH header for all subsequent requests. The login response also provides your networks and the region code required to construct the correct REST endpoint URLs.

Important: Regional Endpoints Depending on your registered region, you must use the appropriate base URL. For example, if your device is registered in Germany, change the endpoint from https://rest.prod.immedia-semi.com to https://rest.prde.immedia-semi.com.

curl -H "Host: prod.immedia-semi.com" -H "Content-Type: application/json" --data-binary '{ "password" : "*your blink password*", "client_specifier" : "iPhone 9.2 | 2.2 | 222", "email" : "*your blink login/email*" }' --compressed https://rest.prod.immedia-semi.com/login

To get real-time sensor information for a specific camera, such as WiFi strength, temperature, and battery level, use the /signals endpoint.

curl -H "Host: prod.immedia-semi.com" -H "TOKEN_AUTH: *authtoken from login*" --compressed https://rest.prod.immedia-semi.com/network/*network_id*/camera/*camera_id*/signals