Skip to main content

Provides a python interface to interact with a hikvision camera

Project description


Pypi Build Status Coverage Status


This is a very basic python module providing a basic python interface to interact with a Hikvision IP Camera

This is licensed under the MIT license.

Getting started

This module is tested against firmware 5.2.0. It may work on older versions, but that has not been tested.

For further info on the camera API's see: CGI API Guide:


hikvision is hosted by Github at

CI run after commit:



git clone --recursive
cd hikvision
# NOTE: You might need administrator privileges to install python modules.
pip install -r requirements.txt
pip install -e .



import hikvision.api

# This will use http by default (not https)
# pass False to the digest_auth parameter of CreateDevice to fallback to basic auth
# (note that basic auth and http without ssl are inherently insecure)
# more recent hikvision firmwares default to turning basic auth off
# (and that's a good idea for security)
hik_camera = hikvision.api.CreateDevice('', username='admin', password='12345')
  • host (*Required) : This is the IP address of your Hikvision camera. Example:

  • username (*Required) : Your Hikvision camera username

  • password (*Required) : Your Hikvision camera username


2.0.3 (07-09-2020)

  • Updated to use travis, tox, and some other cosmetic improvements.

2.0.4 (2020-12-08)

  • Switch pipeline to Github actions

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for hikvision, version 2.0.4
Filename, size File type Python version Upload date Hashes
Filename, size hikvision-2.0.4.tar.gz (6.5 kB) File type Source Python version None Upload date Hashes View
Filename, size hikvision-2.0.4-py2.py3-none-any.whl (7.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page