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 <insert-package-name>

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.get_api_status()
# Sandbox
from nowpayments_api import NOWPaymentsAPI

api_key = 'YOUR_SANDBOX_API_KEY'
nowpayments = NOWPaymentsAPI(api_key, sandbox=True)
status = nowpayments.get_api_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.0.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

nowpayments_api-1.0.0-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nowpayments_api-1.0.0.tar.gz
  • Upload date:
  • Size: 7.7 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.0.tar.gz
Algorithm Hash digest
SHA256 d49b3c1af34c0805e4d307523b57efec39e7abe7a7fd44de5420506d48379406
MD5 28170cc071b66eff2e5d33e86d3008a6
BLAKE2b-256 aa2c70d3c069ea3bba7ac6f1c0fb1680dff1a7aa20e4f8b2e8177a2dd1d15ffc

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: nowpayments_api-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 8.7 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b3dae1462a64a14e4298c0c77ab518a71e2878e38106912b751b443080c457f3
MD5 3ad1b7571bc49c1fc3cb2baa5bab99c9
BLAKE2b-256 d45db28e39695ccdfc1f5ce45475211dafb29a6beec1af71f753fcde9b3d76dd

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