Credits

Contents

  • Endpoints
  • Endpoints

    Get remaining credits

    Get number of available credits for this API key. For test API keys, this will be the number of remaining credits for the day. If an automatic recharge is set up, it will be included in the response. This endpoint has no cost.

    GET/account/credits/remaining

    Examples

    Example Request
    curl "https://api.nettoolkit.com/v1/account/credits/remaining" \
    -H "X-NTK-KEY: $YOUR_KEY_HERE"
    Example Response
    {
        "code": 1000,
        "results": [
            {
                "credits": 999,
                "auto_recharge": {
                    "threshold": 1000,
                    "dollar_amount": 10
                }
            }
        ]
    }

    Estimate cost of credit purchase

    Estimate how much a credit purchase will cost in dollars. This endpoint has no cost.

    GET/account/credits/cost-estimate

    Parameters

    credits(required)number

    Number of credits desired.

    Examples

    Example Request
    curl "https://api.nettoolkit.com/v1/account/credits/cost-estimate" \
    -H "X-NTK-KEY: $YOUR_KEY_HERE" \
    -d credits=250000
    Example Response
    {
        "code": 1000,
        "results": [
            {
                "dollar_amount": 25
            }
        ]
    }