Skip to main content

Introduction

cyjax-cti is a Python library to use Cyjax platform API. You can access different resources (incident reports, threat actors, indicators of compromise, etc.) from a Python script.

The library is available on Python Package Index.

Install

You can install the cyjax-cti library with pip:

pip install cyjax-cti

Supported resources

Resource class Methods
AlertNotifications list
CompromisedCredentials one, sightings
CompromisedDevices list, one, credentials
Dashboard list, list_widgets, get_table_widget, get_mitre_widget, get_metric_widget, get_map_widget, get_counter_widget
DataBreach one, list
IncidentReport one, list
IndicatorOfCompromise list, enrichment
LeakedEmail one, list, search
MaliciousDomain list
Paste one, list
SocialMedia one, list
Supplier create, delete, one, list, update
TailoredReport one, list
ThreatActor list
Tier list
TorExitNode one, list
Tweet list

Examples

Set the API key

import cyjax

# set a global API key
cyjax.api_key = "346568ecf85f0b5ca98f389908e8b803"

# set a resource API key
cyjax.IndicatorOfCompromise(api_key="346568ecf85f0b5ca98f389908e8b803")

Get indicators of compromise in the last 5 minutes

import cyjax
from datetime import timedelta

cyjax.api_key = "346568ecf85f0b5ca98f389908e8b803"

indicators = cyjax.IndicatorOfCompromise().list(since=timedelta(minutes=5))
for indicator in indicators:
    print(indicator)

Get APT activity in last 6 months

import cyjax
from datetime import timedelta

cyjax.api_key = "346568ecf85f0b5ca98f389908e8b803"

reports = cyjax.IncidentReport().list(query="APT", since=timedelta(days=30*6))
for report in reports:
    print("Title: {}" % report['title'])
    print("Severity: {}" % report['severity'])
    print("Timestamp: {}" % report['last_update'])

Get leaked emails in the last 30 days

import cyjax
from datetime import timedelta

cyjax.api_key = "346568ecf85f0b5ca98f389908e8b803"

for leaked_email in cyjax.LeakedEmail().list(since=timedelta(days=30)):
    print("Email: {}" % leaked_email['email'])
    print("Source: {}" % leaked_email['source'])
    print("Timestamp: {}" % leaked_email['discovered_at'])

Get incident report by ID

import cyjax

cyjax.api_key = "346568ecf85f0b5ca98f389908e8b803"

incident_report = cyjax.IncidentReport().one(10)

print("Report title: {}" % incident_report.get('title'))
print("Report severity: {}" % incident_report.get('severity'))
print("Report content: {}" % incident_report.get('content'))

Metadata

Release files for cyjax-cti 2.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for cyjax-cti 2.2.0
File Size Uploaded Provenance Actions
cyjax_cti-2.2.0.tar.gz 53.7 kB Without provenance Details for cyjax_cti-2.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for cyjax-cti 2.2.0
File Interpreter ABI Platform Actions
cyjax_cti-2.2.0-py3-none-any.whl Python 3 none any Details for cyjax_cti-2.2.0-py3-none-any.whl

Total release size: 149.7 kB

Release files / cyjax_cti-2.2.0.tar.gz

Download URL cyjax_cti-2.2.0.tar.gz
Size 53.7 kB
Tags Source
SHA-256 checksum
How to use checksums
f281b3340b317a65c98465602a0fbc4120d3847e476214f4217a0ae61a5503df
BLAKE2b-256 checksum
How to use checksums
23dd820341763431db96678fd64143036331befdee9e3c71bc6b8da2b85d182c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.10.0 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/1.0.0 urllib3/1.26.20 tqdm/4.64.1 importlib-metadata/4.2.0 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.15

Release files / cyjax_cti-2.2.0-py3-none-any.whl

Download URL cyjax_cti-2.2.0-py3-none-any.whl
Size 96.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0c77ae35aa4d47eede84719ea47fe536db1158407605e31809ef88d19701135c
BLAKE2b-256 checksum
How to use checksums
6b8acec29f2e1b79643cb33a192cd1b87d527f0cfe97c9fdd5141b9d985c85a0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.10.0 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/1.0.0 urllib3/1.26.20 tqdm/4.64.1 importlib-metadata/4.2.0 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.15

Security for cyjax-cti 2.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page