BalanceApi.md

locationiq.Api.BalanceApi

All URIs are relative to https://eu1.locationiq.com/v1

Method	HTTP request	Description
Balance	GET /balance.php

Balance

Balance Balance ()

The Balance API provides a count of request credits left in the user's account for the day. Balance is reset at midnight UTC everyday (00:00 UTC).

Example

using System.Collections.Generic;
using System.Diagnostics;
using locationiq.Api;
using locationiq.Client;
using locationiq.Model;

namespace Example
{
    public class BalanceExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://eu1.locationiq.com/v1";
            // Configure API key authorization: key
            Configuration.Default.AddApiKey("key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("key", "Bearer");

            var apiInstance = new BalanceApi(Configuration.Default);

            try
            {
                Balance result = apiInstance.Balance();
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling BalanceApi.Balance: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

Balance

Authorization

key

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Bad Request	-
401	Unauthorized	-
403	The request has been made from an unauthorized domain.	-
404	No location or places were found for the given input	-
429	Request exceeded the rate-limits set on your account	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]