Skip to main content

A Python library for interacting with the YellowChanger service API.

Project description

# YellowChangerAPI

`YellowChangerAPI` is a Python library for interacting with the [YellowChanger](https://yellowchanger.com) service API. The library allows you to get exchange rates, create trades, and get information about trades.

## Installation

To install the library, use the following command:

```sh
pip install yellowchangerapi

Usage

Example of using the library:

from yellow_changer import YellowChanger

def main():
    public_api_key = "your_public_api_key"
    secret_api_key = "your_secret_api_key"

    yellow_changer = YellowChanger(public_api_key, secret_api_key)

    # Get all rates
    rates = yellow_changer.all_rates()
    print(rates)

    # Get destinations list
    destinations_list = yellow_changer.destinations_list()
    print(destinations_list)

    # Get rates in direction USDT
    rates_in_direction_USDT = yellow_changer.rates_in_direction('USDT')
    print(rates_in_direction_USDT)

    # Create a trade
    trade = yellow_changer.create_trade(
        send_name='USDT',
        get_name='USDT',
        send_value=100,
        send_network='TRC20',
        get_network='ERC20',
        get_creds='0x4c...'
    )

    trade_uniq_id = trade.get('uniq_id')

    # Get trade information
    trade_info = yellow_changer.get_info(trade_uniq_id)
    print(trade_info)

if __name__ == '__main__':
    main()

Methods

all_rates()

Gets all exchange rates.

Example:

rates = yellow_changer.all_rates()
print(rates)

destinations_list()

Gets the list of all destinations.

Example:

destinations = yellow_changer.destinations_list()
print(destinations)

rates_in_direction(direction: str)

Gets all exchange rates in a specific direction.

Parameters:

  • direction (str): The direction of the rate, for example, 'USDT'.

Example:

rates = yellow_changer.rates_in_direction('USDT')
print(rates)

get_info(uniq_id: str)

Gets information about a trade by the unique ID of the trade.

Parameters:

  • uniq_id (str): The unique ID of the trade.

Example:

info = yellow_changer.get_info('your_unique_id')
print(info)

create_trade(**kwargs)

Creates a new trade based on the provided parameters.

Example:

trade = yellow_changer.create_trade(
    send_name='USDT',
    get_name='USDT',
    send_value=100,
    send_network='TRC20',
    get_network='ERC20',
    get_creds='0x4c...'
)
print(trade)

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

yellowchangerapi-1.0.0.tar.gz (3.8 kB view hashes)

Uploaded Source

Built Distribution

yellowchangerapi-1.0.0-py3-none-any.whl (4.3 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