coins-ph

Coins.ph API wrapper for Node.js

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

:cloud: Installation

# Using npm
npm install --save coins-ph

# Using yarn
yarn add coins-ph

:clipboard: Example

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

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({}, (err, data) => {
    console.log(err || data);
    // =>
    // [ { 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" }, (err, data) => {
    console.log(err || data);
    // =>
    // [ { 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, cb)

Create a new buyorder

Params

• Object data: The order data as documented here.
• Function cb: The callback function.

markBuyorderPaid(data, cb)

Mark a buy order as paid

Params

• Object data: The order data as documented here.
• Function cb: The callback function.

buyorder(data, cb)

Retrieve an existing buyorder

Params

• Object data: The order data as documented here.
• Function cb: The callback function.

createSellorder(data, cb)

Create a new sellorder

Params

• Object data: The sell order data (documented here).
• Function cb: The callback function.

validateField(data, cb)

Validate field values

Params

• Object data: The post data (documented here).
• Function cb: The callback function.

sellorder(params, cb)

Retrieve an existing sellorder

Params

• Object params: The sell order params (documented here).
• Function cb: The callback function.

transactionHistory(cb)

Gets the transaction history (buyorders).

Params

• Function cb: The callback function.

payinOutlets(params, cb)

Retrieve supported payin-outlets

Params

• Object params: The request params (documented here).
• Function cb: The callback function.

payinOutletFees(params, cb)

Retrieve current payin-outlet-fees

Params

• Object params: The request params (documented here).
• Function cb: The callback function.

payinOutletCategories(params, cb)

Retrieve supported payin-outlet-categories

Params

• Object params: The request params (documented here).
• Function cb: The callback function.

payoutOutlets(params, cb)

Retrieve supported payout-outlets

Params

• Object params: The request params (documented here).
• Function cb: The callback function.

payoutOutlets(params, cb)

payoutOutletCategories Retrieve supported payout-outlet-categories

Params

• Object params: The request params (documented here).
• Function cb: The callback function.

payinOutletFees(params, cb)

payoutOutletFees Retrieve current payout-outlet-fees

Params

• Object params: The request params (documented here).
• Function cb: The callback function.

createPaymentRequest(data, cb)

Create a new payment request

Params

• Object data: The request data (documented here).
• Function cb: The callback function.

paymentRequests(params, cb)

Retrieve an existing or a list of existing payment requests

Params

• Object params: The request params (documented here).
• Function cb: The callback function.

createTransferRequest(data, cb)

Transfer funds between two accounts

Params

• Object data: The request data (documented here).
• Function cb: The callback function.

transfers(params, cb)

Get the list of transfers or a specific one.

Params

• Object params: The params object (documented here).
• Function cb: The callback function.

cryptoAccounts(params, cb)

Retrieve existing crypto-accounts

Params

• Object params: The params object (documented here).
• Function cb: The callback function.

convertFunds(data, cb)

Convert funds between a user's accounts

Params

• Object data: The data object (documented here).
• Function cb: The callback function.

cryptoExchanges(params, cb)

Retrieve current crypto-exchanges

Params

• Object params: The request params (documented here).
• Function cb: The callback function.

cryptoRoutes(cb)

Retrieve existing crypto-routes

Params

• Function cb: The callback function.

cryptoPayments(params, cb)

Get the crypto payments or a specific one.

Params

• Object params: The request params (documented here).
• Function cb: The callback function.

createUser(data, cb)

Create a new user

Params

• Object data: The request data (documented here).
• Function cb: The callback function.

_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, cb)

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.
• Function cb: The callback function.

:yum: How to contribute

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

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:scroll: License

MIT © Ionică Bizău