Skip to main content

SDK for the Ntropy API

Project description

Ntropy SDK

This repository hosts the SDK for the Ntropy API. It provides transaction enrichment and categorization, account ledger and metrics. The full documentation is available at the developer portal.

To obtain an API key, you can follow this guide.

Installation

$ python3 -m pip install --upgrade 'ntropy-sdk'

Quick Start

Enriching your first transaction requires an SDK object and an input Transaction object. The API key can be set in the environment variable NTROPY_API_KEY or in the SDK constructor:

from ntropy_sdk import SDK

sdk = SDK("YOUR-API-KEY")
r = sdk.transactions.create(
    id="4yp49x3tbj9mD8DB4fM8DDY6Yxbx8YP14g565Xketw3tFmn",
    description="AMAZON WEB SERVICES",
    entry_type="outgoing",
    amount=12042.37,
    currency="USD",
    date="2021-11-01",
    location=dict(
        country="US"
    ),
)
print(r)

The returned EnrichedTransaction contains the added information by Ntropy API. You can consult the Enrichment section of the documentation for more information on the parameters for both Transaction and EnrichedTransaction.

Documentation

You can consult in-depth documentation and examples at the developer portal and at the SDK reference.

License:

Free software: MIT license

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

ntropy_sdk-5.2.1.tar.gz (215.5 kB view details)

Uploaded Source

Built Distribution

ntropy_sdk-5.2.1-py2.py3-none-any.whl (48.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file ntropy_sdk-5.2.1.tar.gz.

File metadata

  • Download URL: ntropy_sdk-5.2.1.tar.gz
  • Upload date:
  • Size: 215.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.13

File hashes

Hashes for ntropy_sdk-5.2.1.tar.gz
Algorithm Hash digest
SHA256 7a4b1beca799d6a6d73b7c4c1c2f453bde82a7b8a3402d2e4d0742b63fc9c75a
MD5 9f05ed70e6ab9f0c8f3449f7b31abe08
BLAKE2b-256 6cb9a13939c8c6be8e6413051e49b818d219fbef2ba8e9396b23f0dcba213235

See more details on using hashes here.

File details

Details for the file ntropy_sdk-5.2.1-py2.py3-none-any.whl.

File metadata

  • Download URL: ntropy_sdk-5.2.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 48.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.13

File hashes

Hashes for ntropy_sdk-5.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9dfd2494abe73b7c5f8410f7a522230e81a7d7b7e5c0a290b681b7c447a26b47
MD5 e54d68246c875e3a2f81a8714148b1aa
BLAKE2b-256 bed9422295982b7ea89871b5a3f2219051ec63ade50b5bd4144047f93d5e3c38

See more details on using hashes here.

Supported by

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