Skip to main content

Python API client for OpenCTI.

Project description

OpenCTI client for Python

Website CircleCI readthedocs GitHub release Number of PyPI downloads Slack Status

The official OpenCTI Python client helps developers to use the OpenCTI API by providing easy to use methods and utils. This client is also used by some OpenCTI components.


To install the latest Python client library, please use pip:

$ pip3 install pycti

Local development

# Fork the current repository, then clone your fork
$ git clone
$ cd client-python
$ git remote add upstream
# Create a branch for your feature/fix
$ git checkout -b [branch-name]
# Create a virtualenv
$ python3 -m venv .venv
$ source .venv/bin/activate
# Install the client-python and dependencies for the development and the documentation
$ python3 -m pip install -e .[dev,doc]
# Set up the git hook scripts
$ pre-commit install
# Create your feature/fix
# Create tests for your changes
$ pytest
# Push you feature/fix on Github
$ git add [file(s)]
$ git commit -m "[descriptive message]"
$ git push origin [branch-name]
# Open a pull request


Client usage

To learn about how to use the OpenCTI Python client and read some examples and cases, refer to the client documentation.

API reference

To learn about the methods available for executing queries and retrieving their answers, refer to the client API Reference.


Install dependencies

$ pip install -r ./test-requirements.txt

pytest is used to launch the tests.

Launch tests


Your OpenCTI API should be running. Your should be configured with your API url and your token.


Unit tests

$ pytest ./tests/01-unit/

Integration testing

$ pytest ./tests/02-integration/


OpenCTI is a product designed and developed by the company Filigran.

Project details

Release history Release notifications | RSS feed

Download files

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

Source Distribution

pycti-5.6.2.tar.gz (106.1 kB view hashes)

Uploaded source

Built Distribution

pycti-5.6.2-py3-none-any.whl (176.7 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page