Skip to content

Commit d44119e

Browse files
yongyi520yongyi520
committed
initial commit"
0 parents  commit d44119e

File tree

187 files changed

+28750
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

187 files changed

+28750
-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

‎.swagger-codegen/VERSION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2.4.11-SNAPSHOT

‎.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: 272 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/APIKey.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# BitMexApi.APIKey
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **String** | |
7+
**secret** | **String** | |
8+
**name** | **String** | |
9+
**nonce** | **Number** | |
10+
**cidr** | **String** | | [optional]
11+
**permissions** | [**[XAny]**](XAny.md) | | [optional]
12+
**enabled** | **Boolean** | | [optional] [default to false]
13+
**userId** | **Number** | |
14+
**created** | **Date** | | [optional]
15+
16+

‎docs/APIKeyApi.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# BitMexApi.APIKeyApi
2+
3+
All URIs are relative to *https://www.bitmex.com/api/v1*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**aPIKeyGet**](APIKeyApi.md#aPIKeyGet) | **GET** /apiKey | Get your API Keys.
8+
9+
10+
<a name="aPIKeyGet"></a>
11+
# **aPIKeyGet**
12+
> [APIKey] aPIKeyGet(opts)
13+
14+
Get your API Keys.
15+
16+
### Example
17+
```javascript
18+
var BitMexApi = require('bit_mex_api');
19+
var defaultClient = BitMexApi.ApiClient.instance;
20+
21+
// Configure API key authorization: apiExpires
22+
var apiExpires = defaultClient.authentications['apiExpires'];
23+
apiExpires.apiKey = 'YOUR API KEY';
24+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
25+
//apiExpires.apiKeyPrefix = 'Token';
26+
27+
// Configure API key authorization: apiKey
28+
var apiKey = defaultClient.authentications['apiKey'];
29+
apiKey.apiKey = 'YOUR API KEY';
30+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
31+
//apiKey.apiKeyPrefix = 'Token';
32+
33+
// Configure API key authorization: apiSignature
34+
var apiSignature = defaultClient.authentications['apiSignature'];
35+
apiSignature.apiKey = 'YOUR API KEY';
36+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
37+
//apiSignature.apiKeyPrefix = 'Token';
38+
39+
var apiInstance = new BitMexApi.APIKeyApi();
40+
41+
var opts = {
42+
'reverse': false // Boolean | If true, will sort results newest first.
43+
};
44+
45+
var callback = function(error, data, response) {
46+
if (error) {
47+
console.error(error);
48+
} else {
49+
console.log('API called successfully. Returned data: ' + data);
50+
}
51+
};
52+
apiInstance.aPIKeyGet(opts, callback);
53+
```
54+
55+
### Parameters
56+
57+
Name | Type | Description | Notes
58+
------------- | ------------- | ------------- | -------------
59+
**reverse** | **Boolean**| If true, will sort results newest first. | [optional] [default to false]
60+
61+
### Return type
62+
63+
[**[APIKey]**](APIKey.md)
64+
65+
### Authorization
66+
67+
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#apiSignature)
68+
69+
### HTTP request headers
70+
71+
- **Content-Type**: application/json, application/x-www-form-urlencoded
72+
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
73+

‎docs/AccessToken.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# BitMexApi.AccessToken
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **String** | |
7+
**ttl** | **Number** | time to live in seconds (2 weeks by default) | [optional] [default to 1209600.0]
8+
**created** | **Date** | | [optional]
9+
**userId** | **Number** | | [optional]
10+
11+

‎docs/Affiliate.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# BitMexApi.Affiliate
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**account** | **Number** | |
7+
**currency** | **String** | |
8+
**prevPayout** | **Number** | | [optional]
9+
**prevTurnover** | **Number** | | [optional]
10+
**prevComm** | **Number** | | [optional]
11+
**prevTimestamp** | **Date** | | [optional]
12+
**execTurnover** | **Number** | | [optional]
13+
**execComm** | **Number** | | [optional]
14+
**totalReferrals** | **Number** | | [optional]
15+
**totalTurnover** | **Number** | | [optional]
16+
**totalComm** | **Number** | | [optional]
17+
**payoutPcnt** | **Number** | | [optional]
18+
**pendingPayout** | **Number** | | [optional]
19+
**timestamp** | **Date** | | [optional]
20+
**referrerAccount** | **Number** | | [optional]
21+
**referralDiscount** | **Number** | | [optional]
22+
**affiliatePayout** | **Number** | | [optional]
23+
24+

‎docs/Announcement.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# BitMexApi.Announcement
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **Number** | |
7+
**link** | **String** | | [optional]
8+
**title** | **String** | | [optional]
9+
**content** | **String** | | [optional]
10+
**_date** | **Date** | | [optional]
11+
12+

‎docs/AnnouncementApi.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# BitMexApi.AnnouncementApi
2+
3+
All URIs are relative to *https://www.bitmex.com/api/v1*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**announcementGet**](AnnouncementApi.md#announcementGet) | **GET** /announcement | Get site announcements.
8+
[**announcementGetUrgent**](AnnouncementApi.md#announcementGetUrgent) | **GET** /announcement/urgent | Get urgent (banner) announcements.
9+
10+
11+
<a name="announcementGet"></a>
12+
# **announcementGet**
13+
> [Announcement] announcementGet(opts)
14+
15+
Get site announcements.
16+
17+
### Example
18+
```javascript
19+
var BitMexApi = require('bit_mex_api');
20+
21+
var apiInstance = new BitMexApi.AnnouncementApi();
22+
23+
var opts = {
24+
'columns': "columns_example" // String | Array of column names to fetch. If omitted, will return all columns.
25+
};
26+
27+
var callback = function(error, data, response) {
28+
if (error) {
29+
console.error(error);
30+
} else {
31+
console.log('API called successfully. Returned data: ' + data);
32+
}
33+
};
34+
apiInstance.announcementGet(opts, callback);
35+
```
36+
37+
### Parameters
38+
39+
Name | Type | Description | Notes
40+
------------- | ------------- | ------------- | -------------
41+
**columns** | **String**| Array of column names to fetch. If omitted, will return all columns. | [optional]
42+
43+
### Return type
44+
45+
[**[Announcement]**](Announcement.md)
46+
47+
### Authorization
48+
49+
No authorization required
50+
51+
### HTTP request headers
52+
53+
- **Content-Type**: application/json, application/x-www-form-urlencoded
54+
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
55+
56+
<a name="announcementGetUrgent"></a>
57+
# **announcementGetUrgent**
58+
> [Announcement] announcementGetUrgent()
59+
60+
Get urgent (banner) announcements.
61+
62+
### Example
63+
```javascript
64+
var BitMexApi = require('bit_mex_api');
65+
var defaultClient = BitMexApi.ApiClient.instance;
66+
67+
// Configure API key authorization: apiExpires
68+
var apiExpires = defaultClient.authentications['apiExpires'];
69+
apiExpires.apiKey = 'YOUR API KEY';
70+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
71+
//apiExpires.apiKeyPrefix = 'Token';
72+
73+
// Configure API key authorization: apiKey
74+
var apiKey = defaultClient.authentications['apiKey'];
75+
apiKey.apiKey = 'YOUR API KEY';
76+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
77+
//apiKey.apiKeyPrefix = 'Token';
78+
79+
// Configure API key authorization: apiSignature
80+
var apiSignature = defaultClient.authentications['apiSignature'];
81+
apiSignature.apiKey = 'YOUR API KEY';
82+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
83+
//apiSignature.apiKeyPrefix = 'Token';
84+
85+
var apiInstance = new BitMexApi.AnnouncementApi();
86+
87+
var callback = function(error, data, response) {
88+
if (error) {
89+
console.error(error);
90+
} else {
91+
console.log('API called successfully. Returned data: ' + data);
92+
}
93+
};
94+
apiInstance.announcementGetUrgent(callback);
95+
```
96+
97+
### Parameters
98+
This endpoint does not need any parameter.
99+
100+
### Return type
101+
102+
[**[Announcement]**](Announcement.md)
103+
104+
### Authorization
105+
106+
[apiExpires](../README.md#apiExpires), [apiKey](../README.md#apiKey), [apiSignature](../README.md#apiSignature)
107+
108+
### HTTP request headers
109+
110+
- **Content-Type**: application/json, application/x-www-form-urlencoded
111+
- **Accept**: application/json, application/xml, text/xml, application/javascript, text/javascript
112+

‎docs/Chat.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# BitMexApi.Chat
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**id** | **Number** | | [optional]
7+
**_date** | **Date** | |
8+
**user** | **String** | |
9+
**message** | **String** | |
10+
**html** | **String** | |
11+
**fromBot** | **Boolean** | | [optional] [default to false]
12+
**channelID** | **Number** | | [optional]
13+
14+

0 commit comments

Comments
 (0)