Python library using the MISP Rest API
Pull request Compare This branch is 408 commits ahead, 1 commit behind CIRCL:master.


Documentation Status Build Status Coverage Status

PyMISP - Python Library to access MISP

PyMISP is a Python library to access MISP platforms via their REST API.

PyMISP allows you to fetch events, add or update events/attributes, add or update samples or search for attributes.


Install from pip

pip3 install pymisp

Install the latest version from repo

git clone && cd PyMISP
git submodule update --init
pip3 install -I .

Samples and how to use PyMISP

Various examples and samples scripts are in the examples/ directory.

In the examples directory, you will need to change the to enter your MISP url and API key.

cd examples

The API key of MISP is available in the Automation section of the MISP web interface.

To test if your URL and API keys are correct, you can test with examples/ to fetch the last 10 events published.

cd examples
python3 -l 10


You have two options there:

  1. Pass debug=True to PyMISP and it will enable logging.DEBUG to stderr on the whole module

  2. Use the python logging module directly:

import logging
logger = logging.getLogger('pymisp')

# Configure it as you whish, for example, enable DEBUG mode:

Or if you want to write the debug output to a file instead of stderr:

import pymisp
import logging

logger = logging.getLogger('pymisp')
logging.basicConfig(level=logging.DEBUG, filename="debug.log", filemode='w', format=pymisp.FORMAT)


PyMISP API documentation is available.

Documentation can be generated with epydoc:

epydoc --url --graph all --name PyMISP --pdf pymisp -o doc

Everything is a Mutable Mapping

... or at least everything that can be imported/exported from/to a json blob

AbstractMISP is the master class, and inherit collections.MutableMapping which means the class can be represented as a python dictionary.

The abstraction assumes every property that should not be seen in the dictionary is prepended with a _, or its name is added to the private list __not_jsonable (accessible through update_not_jsonable and set_not_jsonable.

This master class has helpers that will make it easy to load, and export, to, and from, a json string.

MISPEvent, MISPAttribute, MISPObjectReference, MISPObjectAttribute, and MISPObject are subclasses of AbstractMISP, which mean that they can be handled as python dictionaries.

MISP Objects

Creating a new MISP object generator should be done using a pre-defined template and inherit AbstractMISPObjectGenerator.

Your new MISPObject generator need to generate attributes, and add them as class properties using add_attribute.

When the object is sent to MISP, all the class properties will be exported to the JSON export.