coins-ph-promise-native v1.1.9

coins-ph

Coins.ph API wrapper for Node.js (Using promises instead of callbacks).

This is based on Ionică Bizău's work on coins-ph. This API wrapper uses Promises instead of callbacks.

The Coins.ph API Reference is a good resource to learn more about these APIs.

:cloud: Installation

# Using npm
npm install --save coins-ph-promise-native

# Using yarn
yarn add coins-ph-promise-native

:clipboard: Example

const Coins = require("coins-ph-promise-native");

let client = new Coins({
    key: process.env.COINS_PW_KEY
  , secret: process.env.COINS_PW_SECRET

    // This is optional
  , host: process.env.COINS_HOST || "https://coins.ph/"
});

client.cryptoAccounts({}).then((data) => console.log(data))
.catch((err) => console.log(err));
    // =>
    // [ { id: 'ff...c9',
    //     name: 'Default Account',
    //     currency: 'BTC',
    //     balance: '0.09000000',
    //     pending_balance: '0.00000000',
    //     total_received: '0.10168800',
    //     default_address: '34SuY....yp6m' },
    //   { id: '787...283',
    //     name: 'Default Account',
    //     currency: 'CLP',
    //     balance: '0.00000000',
    //     pending_balance: '0.00000000',
    //     total_received: '0.00000000',
    //     default_address: 'bf...129' } ]

client.payinOutlets({ region: "PH" }).then((data) => console.log(data))
.catch((err) => console.log(err));
    // =>
    // [ { id: '..._deposit',
    //     outlet_category: 'atm_deposit',
    //     payment_outlet_type: {...},
    //     amount_limits: [ [Object] ],
    //     denominations: [],
    //     name: '...',
    //     region: '...',
    //     verification_level_requirement: 0,
    //     help_text: '...',
    //     help_link: 'https://coinsph.zendesk.com/hc/en-us/articles/202637070',
    //     instructions: '...',
    //     payout_duration: null,
    //     is_express: false }, ... ]
});

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.

2. For bug reports and feature requests, open issues. :bug:

3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

Coins(options)

Creates the instance of the Coins class.

Params

• Object options: An object containing:
• secret (String): The secret key (mandatory).
• key (String): The API key (mandatory)
• host (String): The coins.ph host (default: https://coins.ph/).

createBuyorder(data)

Create a new buyorder

Params

• Object data: The order data as documented here.

markBuyorderPaid(data)

Mark a buy order as paid

Params

• Object data: The order data as documented here.

buyorder(data)

Retrieve an existing buyorder

Params

• Object data: The order data as documented here.

createSellorder(data)

Create a new sellorder

Params

• Object data: The sell order data (documented here).

validateField(data)

Validate field values

Params

• Object data: The post data (documented here).

sellorder(params)

Retrieve an existing sellorder

Params

• Object params: The sell order params (documented here).

transactionHistory()

Gets the transaction history (buyorders).

Params

payinOutlets(params)

Retrieve supported payin-outlets

Params

• Object params: The request params (documented here).

payinOutletFees(params)

Retrieve current payin-outlet-fees

Params

• Object params: The request params (documented here).

payinOutletCategories(params)

Retrieve supported payin-outlet-categories

Params

• Object params: The request params (documented here).

createPaymentRequest(data)

Create a new payment request

Params

• Object data: The request data (documented here).

paymentRequests(params)

Retrieve an existing or a list of existing payment requests

Params

• Object params: The request params (documented here).

createTransferRequest(data)

Transfer funds between two accounts

Params

• Object data: The request data (documented here).

transfers(params)

Get the list of transfers or a specific one.

Params

• Object params: The params object (documented here).

cryptoAccounts(params)

Retrieve existing crypto-accounts

Params

• Object params: The params object (documented here).

convertFunds(data)

Convert funds between a user's accounts

Params

• Object data: The data object (documented here).

cryptoExchanges(params)

Retrieve current crypto-exchanges

Params

• Object params: The request params (documented here).

cryptoRoutes()

Retrieve existing crypto-routes

Params

cryptoPayments(params)

Get the crypto payments or a specific one.

Params

• Object params: The request params (documented here).

createUser(data)

Create a new user

Params

• Object data: The request data (documented here).

_getNonce()

This is called internally.

Return

• Number The nonce value.

_signRequest(url, body)

Signs a request.

Params

• String url: The request url.
• Object body: The request data.

Return

• Object An object containing:
• signature (String): The HMAC signature.
• nonce (String): The stringified nonce value.

_request(options)

Low level function for making requests to the API endpoints.

Params

• Object options: An object containing the following fields:
• url (String): The api endpoint.
• method (String): The request method (default: get).
• params (Object): The params object.
• data (Object): The POST data object.
• responseField (String): The response field to take.
• version (String): The version endpoint (default: d/api). It could be api/v2 or api/v3 too, depending on the endpoint.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:scroll: License

MIT © Ionică Bizău Converted to promise by Ardee Aram