API

URL

https://api.mothernode.com

API Authentication (HTTP Basic)

curl --request GET \
--url 'https://api.mothernode.com/' \
--user :'

Calculating your own authorization header

Most programming languages encode the authorization header automatically. With HTTP Basic Authentication, the Authorization header is a string containing a Base-64 encoded username and password. In the case of Mothernode’s API, you need to specify the username and your API key.

"Authorization": "Basic " + base64_encode("[Access Key]:[API Password]")

Additional headers

ACCEPT HEADER

Mothernode API returns results as JSON. Your requests should always include the header requesting the results as JSON:

Accept: application/json

CONTENT-TYPE HEADER

When sending data to Mothernode in a POST or PUT request, your request must specify the content type of your request:

Content-Type: application/json

HTTP Status Codes

Every request includes an HTTP status code with the result. The status code should examined before the response.

SUCCESSFUL STATUS CODES (2XX)

200 OK
The request was successful.

201 Created
The resource was successfully created. Confirms a success when creating a new account, credit, subscription, etc.

204 No Content
The request was successful and there is no response body.

CLIENT ERROR STATUS CODES (4XX)

400 Bad Request
The request was invalid or could not be understood by the server. Resubmitting the request will likely result in the same error.

401 Unauthorized
Your API key is missing or invalid.

403 Forbidden
Your API key is missing or invalid.

404 Not Found
The resource was not found with the given identifier.

SERVER ERROR STATUS CODES (5XX)

500 Internal Server Error
The server encountered an error while processing your request and failed.

503 Service Unavailable
The service is temporarily unavailable. Please try the request again.

FUTURE COMPATIBILITY

For future compatibility, please interpret the following status code ranges:

200-299 as success,
400-499 as client request errors,
500-599 as server errors