Skip to content
Metaco API Client for Javascript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist
examples
lib
test
.gitignore
.travis.yml
Gulpfile.js
LICENSE
README.md
bower.json
karma.conf.ci.js
karma.conf.js
package.json

README.md

Metaco API Javascript client Build Status

Metaco REST API provides a set of services to integrate Metaco into third-party applications. It offers trading and payment facilities as well as wallet management features.

Our Javascript Client implements every single functionality of the API. You can find a detailed documentation here : API Documentation.

This library works in NodeJS and in the Browser. We developed it using the commonjs spec, and we're using browserify to bundle the library into a single file usable in the browser.

Installation

Using npm (Nodejs)

npm install metaco-client

Using bower (Browser)

bower install metaco-client

Manually

For nodejs, you can clone our repository, you will get the latest version available.

For the browser :

  • You can download our latest releases on github or in our dist folder.
  • You can clone our repository and run gulp buildBrowser to get the latest bundled version.

Usage

You can use our Unit tests to learn the basics or the links in the summary of this document.

Testing

The tests requires a testnet environnement to work.

Clone our repository and run :

npm install

Define the following environment variables :

  • METACO_ENV_API_ID : Your testnet API ID
  • METACO_ENV_API_KEY : Your testnet API Key
  • METACO_ENV_API_URL : http://api.testnet.metaco.com/v1/ (Or the endpoint you want to run your tests with)
  • METACO_ENV_WALLET_PRIVATE_KEY_HEX : The private key of your testnet wallet (hex-encoded)

Run npm test

Contributing

  1. Fork this repository and make your changes in your fork
  2. Add or Update the tests and run npm test to make sure they pass
  3. Commit and push your changes to your fork git push origin master
  4. Submit a pull request and we will handle the rest :)

Known Issues / Gotcha

  • The api is still unstable.
  • The tests are only on the browser side at the moment.

License

MIT (See LICENSE).

You can’t perform that action at this time.