https://github.com/web3space/web3exchange-api
API for web3 exchange
https://github.com/web3space/web3exchange-api
Last synced: about 1 year ago
JSON representation
API for web3 exchange
- Host: GitHub
- URL: https://github.com/web3space/web3exchange-api
- Owner: web3space
- Created: 2018-10-11T12:45:33.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-14T14:06:11.000Z (over 7 years ago)
- Last Synced: 2025-01-25T14:13:18.232Z (over 1 year ago)
- Language: LiveScript
- Size: 9.77 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Web3 Exchange API
### Install
```
npm i web3exchange-api
```
### How to use
Generate the private key [here](https://www.bitaddress.org/bitaddress.org-v3.3.0-SHA256-dec17c07685e1870960903d8f58090475b25af946fe95a734f88408cef4aa194.html) or another place trusted by you.
Get Address
```Javascript
var builder = require('web3exchange-api');
var privateKey = "cPBn5A4ikZvBTQ8D7NnvHZYCAxzDZ5Z2TSGW2LkyPiLxqYaJPBW4";
var apiUrl = "http://ethnamed.io:8081";
var address = builder.getAddress(privateKey);
```
Contact to API's admin and privide him your address
He have to put your public address into the `config.json/recaptcha/whitelist` on the server
Init the API
```Javascript
var builder = require('web3exchange-api');
var privateKey = "cPBn5A4ikZvBTQ8D7NnvHZYCAxzDZ5Z2TSGW2LkyPiLxqYaJPBW4";
var apiUrl = "http://ethnamed.io:8081";
builder.createApi({ apiUrl, privateKey }, (err, api)=> {
api.convert({ from, to, value, address }, cb);
});
```
### Crypto To Fiat
```Javascript
var request = {
clientid: api.createClientid(),
from: "ETH",
to: "USD",
value: "1", //ETH
address: "0000 0000 0000 0000"
}
var cb = (err, data) {
//Send 1 ETH Here
console.log(data.address);
}
api.convert(request, cb);
```
### Fiat To Crypto
```Javascript
var request = {
clientid: api.createClientid(),
from: "USD",
to: "ETH",
value: "100", //USD
address: "0xbd7ac0f279dc56b61fb10faeaa7fd8da54e92408" //Your ETH address to receive coins
}
var cb = (err, data) {
console.log(data.checkout_url);
}
api.convert(request, cb);
```
You can get an error `KYC is required` so please follow next steps
```Javascript
var request = {
clientid: request.clientid,
email: "you@email.com",
clientid: ""
firstname: "John",
lastname: "Melburn"
address: "8913 3rd Street Brooklyn, NY 11223",
photo: "data:" // Encoded base64, please make sure that photo in correct format
bill: "data:" // Encoded base64, please make sure that bill in correct format
}
var cb = (err, data) {
console.log( err === null);
}
api.kyc(request, cb);
```
[Here](https://www.base64-image.de/) is information how to encode the image.