BalanceApi.md

LocationIQClient::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

# load the gem
require 'locationiq-ruby-client'
# setup authorization
LocationIQClient.configure do |config|
  # Configure API key authorization: key
  config.api_key['key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['key'] = 'Bearer'
end

api_instance = LocationIQClient::BalanceApi.new

begin
  result = api_instance.balance
  p result
rescue LocationIQClient::ApiError => e
  puts "Exception when calling BalanceApi->balance: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Balance

Authorization

key

HTTP request headers

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