Skip to content

Commit 6a62b6b

Browse files
PhearZeroPhearZero
committed
Initial Release
0 parents  commit 6a62b6b

26 files changed

+2876
-0
lines changed

‎.swagger-codegen-ignore

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Swagger Codegen Ignore
2+
# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
3+
4+
# Use this file to prevent files from being overwritten by the generator.
5+
# The patterns follow closely to .gitignore or .dockerignore.
6+
7+
# As an example, the C# client generator defines ApiClient.cs.
8+
# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
9+
#ApiClient.cs
10+
11+
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
12+
#foo/*/qux
13+
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14+
15+
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16+
#foo/**/qux
17+
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18+
19+
# You can also negate patterns with an exclamation (!).
20+
# For example, you can ignore all files in a docs folder with the file extension .md:
21+
#docs/*.md
22+
# Then explicitly reverse the ignore rule for a single file:
23+
#!docs/README.md

‎.travis.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
language: node_js
2+
node_js:
3+
- "6"
4+
- "6.1"
5+
- "5"
6+
- "5.11"
7+

‎README.md

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
# minergate_api
2+
3+
MinergateApi - JavaScript client for minergate_api
4+
*MinerGate is a mining pool created by a group of cryptocoin enthusiasts.* It is the first pool which provides service for merged mining. This means that while mining on our pool you can mine different coins simultaniously without decrease of hashrate for major coin. **If you are interested in cooperation drop a message to [email protected].** | Currency Name | Currency Code (cc) | | --- | --- | | Bitcoin | btc | | Litecoin | ltc | | Bytecoin | bcn | | Monero | xmr | | FantomCoin | fcn | | QuazarCoin | qcn | | DigitalNote | xdn | | MonetaVerde | mcn | | Dashcoin | dsh | | Aeon coin | aeon | | Infinium-8 | inf8 |
5+
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
6+
7+
- API version: 1.0
8+
- Package version: 1.0
9+
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
10+
11+
## Installation
12+
13+
### For [Node.js](https://nodejs.org/)
14+
15+
#### npm
16+
17+
To publish the library as a [npm](https://www.npmjs.com/),
18+
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
19+
20+
Then install it via:
21+
22+
```shell
23+
npm install minergate_api --save
24+
```
25+
26+
#### git
27+
#
28+
If the library is hosted at a git repository, e.g.
29+
https://github.com/GIT_USER_ID/GIT_REPO_ID
30+
then install it via:
31+
32+
```shell
33+
npm install GIT_USER_ID/GIT_REPO_ID --save
34+
```
35+
36+
### For browser
37+
38+
The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
39+
the above steps with Node.js and installing browserify with `npm install -g browserify`,
40+
perform the following (assuming *main.js* is your entry file):
41+
42+
```shell
43+
browserify main.js > bundle.js
44+
```
45+
46+
Then include *bundle.js* in the HTML pages.
47+
48+
## Getting Started
49+
50+
Please follow the [installation](#installation) instruction and execute the following JS code:
51+
52+
```javascript
53+
var MinergateApi = require('minergate_api');
54+
55+
var defaultClient = MinergateApi.ApiClient.instance;
56+
57+
// Configure API key authorization: token
58+
var token = defaultClient.authentications['token'];
59+
token.apiKey = "YOUR API KEY"
60+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
61+
//token.apiKeyPrefix['token'] = "Token"
62+
63+
var api = new MinergateApi.AffiliatesApi()
64+
65+
var callback = function(error, data, response) {
66+
if (error) {
67+
console.error(error);
68+
} else {
69+
console.log('API called successfully. Returned data: ' + data);
70+
}
71+
};
72+
api.getAffiliateChildren(callback);
73+
74+
```
75+
76+
## Documentation for API Endpoints
77+
78+
All URIs are relative to *https://api.minergate.com/1.0*
79+
80+
Class | Method | HTTP request | Description
81+
------------ | ------------- | ------------- | -------------
82+
*MinergateApi.AffiliatesApi* | [**getAffiliateChildren**](docs/AffiliatesApi.md#getAffiliateChildren) | **GET** /affiliate/childrens | Affiliate Childrens
83+
*MinergateApi.AffiliatesApi* | [**getAffiliateLinks**](docs/AffiliatesApi.md#getAffiliateLinks) | **GET** /affiliate/links | Affiliate Links
84+
*MinergateApi.AffiliatesApi* | [**getAffiliateProfit**](docs/AffiliatesApi.md#getAffiliateProfit) | **GET** /affiliate/profit | Affiliate Profit
85+
*MinergateApi.MiningApi* | [**getWorkers**](docs/MiningApi.md#getWorkers) | **GET** /workers | Workers
86+
*MinergateApi.MiningApi* | [**miningStats**](docs/MiningApi.md#miningStats) | **GET** /mining/stats | Mining Stats
87+
*MinergateApi.PaymentsApi* | [**getInvoiceById**](docs/PaymentsApi.md#getInvoiceById) | **GET** /invoices/{INVOICE_ID} | Invoices by Id
88+
*MinergateApi.PaymentsApi* | [**getInvoices**](docs/PaymentsApi.md#getInvoices) | **GET** /invoices | Invoices
89+
*MinergateApi.ProfileApi* | [**getProfileNickname**](docs/ProfileApi.md#getProfileNickname) | **GET** /profile/nickname | Profile Nickname
90+
*MinergateApi.PublicApi* | [**getBlockchainStatus**](docs/PublicApi.md#getBlockchainStatus) | **GET** /{cc}/status | Blockchain Status
91+
*MinergateApi.PublicApi* | [**getPoolProfitRating**](docs/PublicApi.md#getPoolProfitRating) | **GET** /pool/profit-rating | Pool Profit-Rating
92+
*MinergateApi.PublicApi* | [**getPoolTopHashrate**](docs/PublicApi.md#getPoolTopHashrate) | **GET** /pool/top/hashrate | Pool Top Hashrate
93+
*MinergateApi.WalletApi* | [**getBalance**](docs/WalletApi.md#getBalance) | **GET** /balance | Balance
94+
*MinergateApi.WalletApi* | [**getTransfers**](docs/WalletApi.md#getTransfers) | **GET** /transfers/{cc} | Transfers
95+
*MinergateApi.WalletApi* | [**getWithdrawals**](docs/WalletApi.md#getWithdrawals) | **GET** /withdrawals/{cc} | Withdrawals by Blockchain
96+
97+
98+
## Documentation for Models
99+
100+
101+
102+
## Documentation for Authorization
103+
104+
105+
### token
106+
107+
- **Type**: API key
108+
- **API key parameter name**: token
109+
- **Location**: HTTP header
110+

‎docs/AffiliatesApi.md

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
# MinergateApi.AffiliatesApi
2+
3+
All URIs are relative to *https://api.minergate.com/1.0*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**getAffiliateChildren**](AffiliatesApi.md#getAffiliateChildren) | **GET** /affiliate/childrens | Affiliate Childrens
8+
[**getAffiliateLinks**](AffiliatesApi.md#getAffiliateLinks) | **GET** /affiliate/links | Affiliate Links
9+
[**getAffiliateProfit**](AffiliatesApi.md#getAffiliateProfit) | **GET** /affiliate/profit | Affiliate Profit
10+
11+
12+
<a name="getAffiliateChildren"></a>
13+
# **getAffiliateChildren**
14+
> Object getAffiliateChildren()
15+
16+
Affiliate Childrens
17+
18+
Returns the list of user’s affiliates. **Requires authorization.**
19+
20+
### Example
21+
```javascript
22+
var MinergateApi = require('minergate_api');
23+
var defaultClient = MinergateApi.ApiClient.default;
24+
25+
// Configure API key authorization: token
26+
var token = defaultClient.authentications['token'];
27+
token.apiKey = 'YOUR API KEY';
28+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
29+
//token.apiKeyPrefix = 'Token';
30+
31+
var apiInstance = new MinergateApi.AffiliatesApi();
32+
33+
var callback = function(error, data, response) {
34+
if (error) {
35+
console.error(error);
36+
} else {
37+
console.log('API called successfully. Returned data: ' + data);
38+
}
39+
};
40+
apiInstance.getAffiliateChildren(callback);
41+
```
42+
43+
### Parameters
44+
This endpoint does not need any parameter.
45+
46+
### Return type
47+
48+
**Object**
49+
50+
### Authorization
51+
52+
[token](../README.md#token)
53+
54+
### HTTP request headers
55+
56+
- **Content-Type**: Not defined
57+
- **Accept**: application/json
58+
59+
<a name="getAffiliateLinks"></a>
60+
# **getAffiliateLinks**
61+
> Object getAffiliateLinks()
62+
63+
Affiliate Links
64+
65+
Returns the list of user’s affiliate links. **Requires authorization.**
66+
67+
### Example
68+
```javascript
69+
var MinergateApi = require('minergate_api');
70+
var defaultClient = MinergateApi.ApiClient.default;
71+
72+
// Configure API key authorization: token
73+
var token = defaultClient.authentications['token'];
74+
token.apiKey = 'YOUR API KEY';
75+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
76+
//token.apiKeyPrefix = 'Token';
77+
78+
var apiInstance = new MinergateApi.AffiliatesApi();
79+
80+
var callback = function(error, data, response) {
81+
if (error) {
82+
console.error(error);
83+
} else {
84+
console.log('API called successfully. Returned data: ' + data);
85+
}
86+
};
87+
apiInstance.getAffiliateLinks(callback);
88+
```
89+
90+
### Parameters
91+
This endpoint does not need any parameter.
92+
93+
### Return type
94+
95+
**Object**
96+
97+
### Authorization
98+
99+
[token](../README.md#token)
100+
101+
### HTTP request headers
102+
103+
- **Content-Type**: Not defined
104+
- **Accept**: application/json
105+
106+
<a name="getAffiliateProfit"></a>
107+
# **getAffiliateProfit**
108+
> Object getAffiliateProfit()
109+
110+
Affiliate Profit
111+
112+
Returns the user’s income from affiliates. **Requires authorization.**
113+
114+
### Example
115+
```javascript
116+
var MinergateApi = require('minergate_api');
117+
var defaultClient = MinergateApi.ApiClient.default;
118+
119+
// Configure API key authorization: token
120+
var token = defaultClient.authentications['token'];
121+
token.apiKey = 'YOUR API KEY';
122+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
123+
//token.apiKeyPrefix = 'Token';
124+
125+
var apiInstance = new MinergateApi.AffiliatesApi();
126+
127+
var callback = function(error, data, response) {
128+
if (error) {
129+
console.error(error);
130+
} else {
131+
console.log('API called successfully. Returned data: ' + data);
132+
}
133+
};
134+
apiInstance.getAffiliateProfit(callback);
135+
```
136+
137+
### Parameters
138+
This endpoint does not need any parameter.
139+
140+
### Return type
141+
142+
**Object**
143+
144+
### Authorization
145+
146+
[token](../README.md#token)
147+
148+
### HTTP request headers
149+
150+
- **Content-Type**: Not defined
151+
- **Accept**: application/json
152+

0 commit comments

Comments
 (0)