circle-api
About
Description
A nodejs module for interacting with the Circle API.
Donations welcomed at: 1CniXdfgpAbM3pYbbLvooRZAGhTEpTMjkN
Author
Norman Joyner - norman.joyner@gmail.com
Getting Started
Installation
npm install circle-api
Configuration
Simply require the circle-api module, instantiate a new Circle-Api object, configure it if necessary, and start making calls. The mfa secret and api version are configurable. Your Circle account must be set up to use Google Authenticator, rather than text messaged based MFA.
New Circle-Api objects can be instantiated with configuration parameters. Here is an example:
var CircleApi = ;var circle_api = api_version: "v2" mfa_secret: "NVTGCX3TMVRXEZLU";
Circle-Api objects can also be configured via the .configure(options)
method. Here is an exmaple:
var CirlceApi = ;var circle_api = ; var options = mfa_secret: "NVTGCX3TMVRXEZLU" circle_api;
Options
api_version
- [optional, defaults to "v2"] version of the API to use
mfa_secret
- [required] totp secret
Finding MFA Secret
Before scanning the Google Authenticator code with your application of choice, first scan the QR code with a QR code app. View the url the QR contains and you will see something similar to: otpauth://totp/Circle%3Ayour%40email.com?secret=NVTGCX3TMVRXEZLU&issuer=Circle
Take notice to what 'secret' is equal to in the url and use this as the mfa_secret
.
Supported API versions
- v2
Supported API Methods
- Logging In -
circle_api.login(options, fn)
- Getting Account Information -
circle_api.get_account(fn)
- Getting Activities -
cirlce_api.get_activities(fn)
- Getting History -
cirlce_api.get_history(fn)
- Getting Bitcoin Address -
circle_api.get_address(fn)
- Getting Personal Information -
circle_api.get_personal_information(fn)
- Getting Fiat Accounts -
circle_api.get_fiat_accounts(fn)
- Depositing Money -
circle_api.deposit(options, fn)
- Sending Money -
circle_api.send(options, fn)
- Requesting Money -
circle_api.request(options, fn)
Examples
Before making future API calls, you must first login:
circle_api;
Once logged in you can make additional calls.
Fetch account information, and print response:
circle_api;
Fetch account activities, and print response:
circle_api;
Fetch account activities, and print response:
circle_api;
Fetch account history, and print response:
circle_api;
Get bitcoin address, and print response:
circle_api;
Get personal information, and print response:
circle_api;
Get fiat accounts, and print response:
circle_api;
Deposit $1 from fiat account, and print response:
circle_api.deposit({"fiat_address": "fiat-account-address", amount: 1.0}, function(err, response){
if(err)
throw err;
console.log(response);
});
Send $1 to bitcoin address (or email address), and print response:
circle_api.send({"address": "1CniXdfgpAbM3pYbbLvooRZAGhTEpTMjkN", amount: 1.0}, function(err, response){
if(err)
throw err;
console.log(response);
});
Request $1 from email address, and print response:
circle_api.request({"email": "someones@email.com", amount: 1.0}, function(err, response){
if(err)
throw err;
console.log(response);
});