API Status

API Status Checking Methods

Available Methods

• Get Job Status

• Get API Key Status

Get Job Status

• Request URL: http://datamonkey.org/api/v1/status

Example Code:

Python

import requests
URL = 'http://datamonkey.org/api/v1/status'
BODY = { 'method': 'FEL', 'id': '5ef23c1f38c6edc2a03d2b10'}
req = requests.get(URL, json = BODY)
data = req.json()
print(data)

Javascript

var request = require("request");
request(
    {
        method: 'GET',
        uri: 'http://datamonkey.org/api/v1/status',
        json: true,
        body: {method: "FEL", id: "5ef23c1f38c6edc2a03d2b10"}
    }, function (err, res, body) {
        if(err){console.error('error:', err)};
        console.log('statusCode:', res && res.statusCode);
        console.log('body:', body);
});

API format:

Method: GET
Body: JSON
Response: JSON

Example Body:

{
  "method": "FEL",
  "id": "5ef23c1f38c6edc2a03d2b10"
}

Example Reply:

{
    "completion": "2020-06-23T17:30:12.000Z",
    "id": "5ef23c1f38c6edc2a03d2b10",
    "status": "completed",
    "url": "datamonkey.org/FEL/5ef23c1f38c6edc2a03d2b10"
}

Get API Key Status

• Request URL: http://datamonkey.org/api/v1/keyinfo

Example Code:

Python

import requests
URL = 'http://datamonkey.org/api/v1/keyInfo'
BODY = {'api_key': 'Your API Key'}
req = requests.post(URL, json = BODY)
data = req.json()
print(data)

Javascript

var request = require("request");
request(
    {
        method: 'POST',
        uri: 'http://datamonkey.org/api/v1/keyInfo',
        json: true,
        body: {api_key: "Your API Key"}
    }, function (err, res, body) {
        if(err){console.error('error:', err)};
        console.log('statusCode:', res && res.statusCode);
        console.log('body:', body);
});

API format:

Method: POST
Body: JSON
Response: JSON

Example Body:

{
  "api_key": "Your API Key"
}

Example Reply:

{
    "_id": "Your API Key",
    "__v": 3,
    "associated_job_ids": [
        "datamonkey.org/FEL/5f0f0d95ba5dd5a981b52fbb",
        "datamonkey.org/FEL/5f0f0da7ba5dd5a981b52fd3",
        "datamonkey.org/FEL/5f0f0da8ba5dd5a981b52feb"
    ],
    "job_remaining": 97,
    "job_request_made": 3,
    "job_request_limit": 100,
    "expires": "2020-08-04T14:03:26.431Z",
    "created": "2020-07-15T14:04:16.881Z"
}