URL: https://www.coinsoftworks.com/contact-us
A reference to the coinsoftworks REST APIs. By using our API, you agree to our terms and services.
The base API url is: https://www.coinsoftworks.com/_function
The general workflow is as follows:
-
Authenticate
-
Query for Actions
-
Execute the action with custom parameters or not
-
Poll/monitor action for completion
API requests are subject to throttling, and you will receive an HTTP 503 error if you are subject to throttling due to excessive queries.
This page is solely a summary of our API and its general concept. To view the complete list of API options, please consult the private library you will receive after upgrading your account. There are all the ready-to-use queries, as well as a ton more, to help you get the most out of your API from the start. As an individual or a business, there is an extensive list of requests. Please contact us if you are a developer with any concerns. We will gladly provide you with additional information.
REST API (v1)
Authentication
Issue a HTTP POST request with a 'X-SIMPLE-API-ACCESS-TOKEN' header that has your Simple Access Token (starts with '1_') as the value. //EXAMPLE: X-SIMPLE-API-ACCESS-TOKEN:1_your_simple_access_token
Simple Access Token Authentication
Generates a bearer token from your simple access token.
When authentication is successful, a bearer token is returned. This token must be included in subsequent queries as an Authorization: Bearer header. After this token EXPIRES, a new bearer token must be obtained by resubmitting a request to this endpoint.
All future requests must use Bearer Authorization where the header is:
Authorization: Bearer {Bearer Token}
//EXAMPLE: Authorization: Bearer eyxCbGciOiJIUzI1Nis...5xywLoYVqTcXDexbC8
If you access this endpoint too frequently, you'll receive an HTTP 429 error. The bearer token must be cached and utilized until its expiration date approaches.
URL PARAMETERS
ACCOUNT-API-ACCESS-KEY
string
Response
RESPONSE SCHEMA: application/json
200 Ok
ticks
integer <int64>
Ticks before the bearer token will expire.
expiration
string <date-time>
Timestamp, in UTC, after which a new bearer token will have to be obtained or all requests will result in a 401 Unauthorized.
bearer_token
string or null
Token to be provided with all api requests in the form of a bearer token authorization header. See https://tools.ietf.org/html/rfc6750 for more details.
Response Example
400 Bad Request (check the content of your request)
429 Too many requests (avoid sending too many requests)
500 Unauthorized (check your account API Key or enable it through the settings)
GET /_functions/authentication/$YOUR-API-KEY$
{
"bearer_token": "eyxCbGciOiJIUzI1Nis...5xywLoYVqTcXDexbC8",
"expiration": "2012-05-01T15:20:22Z",
"ticks": 636607848220000000
}
application/json
Content Type
Settings
Get settings
A valid bearer token is required to complete this request. Obtained from the /_functions/authentication/ endpoint.
Response
RESPONSE SCHEMA: application/json
200 Ok
enterprise_mode
boolean
Check if the enterprise mode is enabled or not.
settings_list
jsonObject
Token to be provided with all api requests in the form of a bearer token authorization header. See https://tools.ietf.org/html/rfc6750 for more details.
500 Unauthorized (check your account API Key or enable it through the settings)
Response Example
GET /_functions/settings/$YOUR-API-KEY$
{
"settings_list": jsonObject,
"enterprise_mode": "true",
}
application/json
Content Type
Actions
Get all actions
Returns a collection of all accessible actions. A bearer token that is legitimate is required to complete this request. Obtained from the authentication endpoint of the API.
Response
RESPONSE SCHEMA: application/json
200 Ok
action_type
string
Retrieve action type. E.g. eMining action, eWallet action...
action_name
string
Retrieve action name. E.g. Send, Transfer, Swap etc... You will obtain a numbered list of all the possible actions with these parameters.
500 Unauthorized (check your account API Key or enable it through the settings)
Response Example
GET /_functions/settings/$YOUR-API-KEY$
[
{
"action_name": Send BTC,
"action_type": "eWallet Action",
"action_id": "33",
"action_status": "Enabled",
}
...
]
application/json
Content Type
Array [
action_id
integer <int32>
Retrieve the ID of the action.
action_status
string (AvailabilityStatus)
Retrieve if the action is enabled, disabled.
...
]
User
Get all actions
A valid bearer token is required to complete this request. Obtained from the api/authentication endpoint.
Response
RESPONSE SCHEMA: application/json
200 Ok
purchased_plan
string
Retrieves the account's current purchased plan.
username
string
Retrieves the account username. No API solicitation balance will be utilized via enterprise mode. You can combine this call with many other account with a valid purchased plan.
500 Unauthorized (check your account API Key or enable it through the settings)
Response Example
GET /_functions/user/$YOUR-API-KEY$
{
"username": JohnCB5496,
"purchased_plan": "Ultimate",
}
application/json
Content Type
Private Library
Go further with your API Access
Discover the comprehensive documentation of over 40 pages with ready-to-use concrete examples that will ignite your results.