Skip to main content

A Python Wrapper for the SNDBOX Rest API

Project description

SNDBOX-LIGHT-API

A Light wrapper for the SNDBOX Rest API written in Python3. This wrapper can be used to communicate to the SNDBOX exposed Rest API to all for the submissions of samples to the platform. As per the documentation found at: https://app.sndbox.com/docs/api The wrapper allows for the three functions:

Search - Search the database for a md5hash.
Submit - Submit a sample to the platform.
Metadata - Gather information about a uploaded file.

In order to use the API you must first obtain a API Key, This is found by registering a account with SNDBOX(https://app.sndbox.com/register) Then navigating to the profile section.

Below are the requirements for each function:

search(apikey='123',md5hash='1bed6d8bdf2c1b7fd5e6badc08e7634a')
submit(apikey='123',file='testsample.docx',email=False)    
metadata(apikey='123',id='12345-33422-23134-122')

Providing all input is correct each function returns the full raw response from the SNDBOX Rest API.

this package relies on requests to make its calls, Please install requests with:

pip install requests

You can also install this package via pip with:

pip install sndboxapi

import the package into your code with:

from sndbox import sndboxapi

Project details


Release history Release notifications | RSS feed

This version

3.0

Download files

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

Source Distribution

sndboxapi-3.0.tar.gz (2.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sndboxapi-3.0-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

Details for the file sndboxapi-3.0.tar.gz.

File metadata

  • Download URL: sndboxapi-3.0.tar.gz
  • Upload date:
  • Size: 2.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7

File hashes

Hashes for sndboxapi-3.0.tar.gz
Algorithm Hash digest
SHA256 ddfcd566eba1e7455aa861d33521c4b3a77b11b6f1dbfdaa8acbc0b59e9ea9e0
MD5 f3631d3e81f3a4675f42101d67d97940
BLAKE2b-256 f916c38e75bcfec92ff7a94af8d1a7eb972a85cd808b8c50e48851e01bf2b03a

See more details on using hashes here.

File details

Details for the file sndboxapi-3.0-py3-none-any.whl.

File metadata

  • Download URL: sndboxapi-3.0-py3-none-any.whl
  • Upload date:
  • Size: 4.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.7

File hashes

Hashes for sndboxapi-3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 60cf8ab7617343eab5c08ec2a0e9993c0372fc165f3abbe42ac9f95d678e1756
MD5 436e9318c5728c5219fe9d316101714c
BLAKE2b-256 f15c4cebdbe78c54058e9265b8807169c765b94d487376714aa65c81aa0abf3e

See more details on using hashes here.

Supported by

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