Skip to main content

A Python wrapper for the NOWPayments API.

Project description

NOWPayments API

Black Code style: black

A Python wrapper for the NOWPayments API, allowing easy integration with the NowPayments platform in Python applications. The api call descriptions are from the official documentation.

Table of Contents

Installation

Make sure you have Python and pip installed. Install by running:

pip install nowpayments-api

Usage

  1. Obtain your NowPayments API key.

    1. From NowPayments Dashboard or
    2. From NowPayments Sandbox Dashboard
  2. Create an instance of the NowPaymentsAPI class based on your API key:

# Production
from nowpayments_api import NOWPaymentsAPI

api_key = 'YOUR_API_KEY'
nowpayments = NOWPaymentsAPI(api_key)
status = nowpayments.status()
# Sandbox
from nowpayments_api import NOWPaymentsAPI

api_key = 'YOUR_SANDBOX_API_KEY'
nowpayments = NOWPaymentsAPI(api_key, sandbox=True)
status = nowpayments.status()

Project Status

This project is under active development. Below are the implemented API methods

Auth and API Status

  • GET API Status
  • POST Auth

Currencies

  • GET Available Currencies
  • GET Available Currencies Full / Detailed
  • GET Available Currencies Checked

Payments

  • POST Create invoice
  • POST Create payment
  • POST Create payment by invoice
  • POST Update payment estimate
  • GET Estimate price
  • GET Payment Status
  • GET List of payments
  • GET Minimum payment amount

Mass Payout

TBA

Conversions

TBA

Custody

TBA

Documentation

For more details on available API methods and parameters, refer to the NowPayments API Documentation.

Contributing

Contributions are welcome!
If you find any issues or have suggestions for improvements, please open an issue or create a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

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

nowpayments_api-1.0.2.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

nowpayments_api-1.0.2-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file nowpayments_api-1.0.2.tar.gz.

File metadata

  • Download URL: nowpayments_api-1.0.2.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.12 Linux/6.5.4-2-liquorix-amd64

File hashes

Hashes for nowpayments_api-1.0.2.tar.gz
Algorithm Hash digest
SHA256 4a64b8b3f49bbfbef1fd949bf376175927d952f71038abdc067bd66dde63c000
MD5 545c4ee31834034c7e7edcc7c164e32a
BLAKE2b-256 3ea7754575b181882eb4edd049772204ec34928c1b6079126153f03f0cef9d2b

See more details on using hashes here.

Provenance

File details

Details for the file nowpayments_api-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: nowpayments_api-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 9.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.12 Linux/6.5.4-2-liquorix-amd64

File hashes

Hashes for nowpayments_api-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a90106ae1668a87f3317face662b73de208c4ee0d4c0c5771a0e8c1405114769
MD5 9e1d4a02ef53833087149344dcbb4ceb
BLAKE2b-256 8dc27075fafe5f02ec63781375240383ef8dbb83ed01b2b99cbbf5ab5a316a52

See more details on using hashes here.

Provenance

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