balance

Determine your credit balance or DPU balance.

An HTTPS GET request sent to:

https://api.datasift.com/v1.3/balance

A successful call to this endpoint returns: 200 OK plus a JSON object.

Parameters

Parameter Description

Examples

  1. Here's an example of a call to /balance for pay-as-you-go customers:

    curl -X GET https://api.datasift.com/v1.3/balance 
        -H 'Authorization: datasift-user:your-datasift-api-key'

    The returned JSON object has this form:

    {
         "balance": {
           "plan": "payg",
           "credit": 206.74
         }
      }

    Property: Description:
    plan This example shows a customer who is using our Pay As You Go plan.
    credit The credit remaining on this Pay As You Go plan.
  2. Here's an example of a call to /v1.3/balance for subscribers.

    curl -X GET https://api.datasift.com/v1.3/balance 
        -H 'Authorization: datasift-user:your-datasift-api-key'

    The returned JSON object has this form:

    {
         "balance": {
           "plan": "Platinum",
           "cost": 0,
           "remaining_dpus": 249993.7
         }
      }

Property: Description:
cost The license cost for your data plus, if your remaining_dpus falls to zero and you continue to run streams, the additional DPU cost you have incurred so far this month.
remaining_dpus The DPUs remaining on this plan for the current month.

Notes

  1. All calls to the API must be properly authenticated with a DataSift username and API key.
  2. All calls to the API must be versioned. The current version is v1.3.

Resource information

Rate limit cost: 25

Requires authentication: Yes

Response formats: JSON, JSONP