coins-ph
Coins.ph API wrapper for Node.js
The Coins.ph API Reference is a good resource to learn more about these APIs.
☁️ Installation
$ npm i --save coins-ph
📋 Example
const Coins = require("coins-ph");
let client = new Coins({
key: process.env.COINS_PW_KEY
, secret: process.env.COINS_PW_SECRET
});
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 }, ... ]
});
📝 Documentation
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.
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.
createPaymentRequest(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 beapi/v2
orapi/v3
too, depending on the endpoint.- Function
cb
: The callback function.
😋 How to contribute
Have an idea? Found a bug? See how to contribute.