All URIs are relative to /v2.5.0
| Method | HTTP request | Description |
|---|---|---|
| addNode | POST /node | Add a node to connect |
| addToBlacklist | POST /blacklist | Add an IP to blacklist |
| addToWhitelist | POST /whitelist | Add an IP to whitelist |
| getInfo | GET /info | Get node info |
| getPeers | GET /peers | Get all peers |
| getPendingTransactions | GET /pending-transactions | Get pending transactions |
| getSyncingStatus | GET /syncing | Get syncing status |
AddNodeResponse addNode(node)
Add a node to connect
Adds a node to node manager.
// Import classes:
//import org.semux.sdk.client.ApiClient;
//import org.semux.sdk.client.ApiException;
//import org.semux.sdk.client.Configuration;
//import org.semux.sdk.client.auth.*;
//import org.semux.sdk.client.api.NodeApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
NodeApi apiInstance = new NodeApi();
String node = "node_example"; // String | Address of the node in host:port format
try {
AddNodeResponse result = apiInstance.addNode(node);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NodeApi#addNode");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| node | String | Address of the node in host:port format |
- Content-Type: Not defined
- Accept: application/json
AddToBlacklistResponse addToBlacklist(ip)
Add an IP to blacklist
Adds an IP address to blacklist.
// Import classes:
//import org.semux.sdk.client.ApiClient;
//import org.semux.sdk.client.ApiException;
//import org.semux.sdk.client.Configuration;
//import org.semux.sdk.client.auth.*;
//import org.semux.sdk.client.api.NodeApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
NodeApi apiInstance = new NodeApi();
String ip = "ip_example"; // String | IP address
try {
AddToBlacklistResponse result = apiInstance.addToBlacklist(ip);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NodeApi#addToBlacklist");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| ip | String | IP address |
- Content-Type: Not defined
- Accept: application/json
AddToWhitelistResponse addToWhitelist(ip)
Add an IP to whitelist
Adds an IP address to whitelist.
// Import classes:
//import org.semux.sdk.client.ApiClient;
//import org.semux.sdk.client.ApiException;
//import org.semux.sdk.client.Configuration;
//import org.semux.sdk.client.auth.*;
//import org.semux.sdk.client.api.NodeApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
NodeApi apiInstance = new NodeApi();
String ip = "ip_example"; // String | IP address
try {
AddToWhitelistResponse result = apiInstance.addToWhitelist(ip);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NodeApi#addToWhitelist");
e.printStackTrace();
}| Name | Type | Description | Notes |
|---|---|---|---|
| ip | String | IP address |
- Content-Type: Not defined
- Accept: application/json
GetInfoResponse getInfo()
Get node info
Returns kernel info.
// Import classes:
//import org.semux.sdk.client.ApiClient;
//import org.semux.sdk.client.ApiException;
//import org.semux.sdk.client.Configuration;
//import org.semux.sdk.client.auth.*;
//import org.semux.sdk.client.api.NodeApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
NodeApi apiInstance = new NodeApi();
try {
GetInfoResponse result = apiInstance.getInfo();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NodeApi#getInfo");
e.printStackTrace();
}This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
GetPeersResponse getPeers()
Get all peers
Returns all connected peers.
// Import classes:
//import org.semux.sdk.client.ApiClient;
//import org.semux.sdk.client.ApiException;
//import org.semux.sdk.client.Configuration;
//import org.semux.sdk.client.auth.*;
//import org.semux.sdk.client.api.NodeApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
NodeApi apiInstance = new NodeApi();
try {
GetPeersResponse result = apiInstance.getPeers();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NodeApi#getPeers");
e.printStackTrace();
}This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
GetPendingTransactionsResponse getPendingTransactions()
Get pending transactions
Returns all the pending transactions.
// Import classes:
//import org.semux.sdk.client.ApiClient;
//import org.semux.sdk.client.ApiException;
//import org.semux.sdk.client.Configuration;
//import org.semux.sdk.client.auth.*;
//import org.semux.sdk.client.api.NodeApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
NodeApi apiInstance = new NodeApi();
try {
GetPendingTransactionsResponse result = apiInstance.getPendingTransactions();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NodeApi#getPendingTransactions");
e.printStackTrace();
}This endpoint does not need any parameter.
GetPendingTransactionsResponse
- Content-Type: Not defined
- Accept: application/json
GetSyncingStatusResponse getSyncingStatus()
Get syncing status
Returns an object with data about the sync status
// Import classes:
//import org.semux.sdk.client.ApiClient;
//import org.semux.sdk.client.ApiException;
//import org.semux.sdk.client.Configuration;
//import org.semux.sdk.client.auth.*;
//import org.semux.sdk.client.api.NodeApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
NodeApi apiInstance = new NodeApi();
try {
GetSyncingStatusResponse result = apiInstance.getSyncingStatus();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling NodeApi#getSyncingStatus");
e.printStackTrace();
}This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json