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.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.1.tar.gz (7.7 kB view hashes)

Uploaded Source

Built Distribution

nowpayments_api-1.0.1-py3-none-any.whl (8.7 kB view hashes)

Uploaded 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