Skip to main content

Python client library for SandCage's API

Project description

sandcage-api-python is a python library for interfacing with SandCage’s API. The API documentation can be found at SandCage’s API documentation


  • certifi

  • requests

In order to use the library you need a SandCage API Key. Once logged into SandCage, you can get your API Key from here.


Using pip:

pip install sandcage

or alternatively clone and install:

git clone
cd sandcage-api-python
python install



from sandcage import SandCage

sc = SandCage('[YOUR_SANDCAGE_API_KEY]')

See more examples

To not include YOUR_SANDCAGE_API_KEY into your code you can for example save it as a file named SANDCAGE_API_KEY into your home directory:

cd ~

and then use the following code to initialize SandCage:

import os.path
from sandcage import SandCage

api_key_dir = os.path.expanduser('~')
api_key_file = os.path.join(api_key_dir, 'SANDCAGE_API_KEY')
with open(api_key_file, 'r') as f:
    api_key = f.readline()

sc = SandCage(api_key=api_key)


We are open to suggestions and code revisions, however there are some rules and limitations that you might want to consider first.

  • Code that you contribute will automatically be licensed under the Apache License Version 2.0.

  • Third party code will be reviewed, tested and possibly modified before being released.

These basic rules help ensure that this code remains Open Source and compatible with Apache 2.0 license. All contributions will be added to the changelog and appear in every release.

Project details

Download files

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

Source Distribution

sandcage-0.2.0.tar.gz (4.0 kB view hashes)

Uploaded Source

Built Distribution

sandcage-0.2.0-py2.py3-none-any.whl (5.3 kB view hashes)

Uploaded Python 2 Python 3

Supported by

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