gmaps.dev Usage API
The Usage API from gmaps.dev — 1 operation(s) for usage.
The Usage API from gmaps.dev — 1 operation(s) for usage.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/gmaps-dev:gmaps-dev-usage-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Gmaps Dev Usage API
version: 0.1.0
description: 'Operations tagged Usage across 2 of this provider''s published API definitions: openapi.json, gmaps-dev-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.gmaps.dev/v1
tags:
- name: Usage
x-displayName: Usage
paths:
/usage:
get:
operationId: get_usage
tags:
- Usage
summary: Get credit usage
description: 'See this month''s credits: what your plan includes, what you have used, what is left today and this month, and the same totals for each API key. Needs an API key. Costs no credits.'
security:
- apiKey: []
responses:
'200':
description: Get credit usage
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
plan:
type: string
enum:
- free
- starter
- pro
- scale
- internal
description: Your plan's id, such as free or pro.
month:
type: string
pattern: ^\d{4}-\d{2}$
description: The month these numbers cover, in UTC, as YYYY-MM.
creditsIncluded:
type: integer
minimum: 0
maximum: 9007199254740991
description: Credits your plan gives you this month.
creditBalance:
type: integer
minimum: 0
maximum: 9007199254740991
description: Credits you bought and haven't used. They never expire.
creditsRemaining:
type: integer
minimum: 0
maximum: 9007199254740991
description: 'Credits you can still spend: what is left of this month''s plus the ones you bought.'
dailyCreditCap:
type: integer
minimum: 0
maximum: 9007199254740991
description: The most credits you can spend in one UTC day. Bought credits don't raise it.
resetAt:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
description: 'When this month''s credits start again: midnight UTC on the 1st.'
dailyResetAt:
type: string
format: date-time
pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
description: 'When today''s limit starts again: the next midnight UTC.'
keys:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
description: Our id for the key.
name:
type: string
description: The name you gave the key.
prefix:
type: string
description: The first characters of the key, for telling keys apart in a list.
kind:
type: string
enum:
- api
- dashboard
description: '`api` for a key you made, `dashboard` for the console''s own.'
revoked:
type: boolean
description: True once the key is revoked. Its usage still counts.
creditsUsed:
type: integer
minimum: 0
maximum: 9007199254740991
description: Credits spent this month after refunds, bought ones included.
balanceCreditsUsed:
type: integer
minimum: 0
maximum: 9007199254740991
description: The part of `creditsUsed` paid with bought credits, after refunds.
dailyCreditsUsed:
type: integer
minimum: 0
maximum: 9007199254740991
description: Credits spent today, UTC.
calls:
type: integer
minimum: 0
maximum: 9007199254740991
description: How many times credits were charged, not how many requests were made. A refund doesn't take one back.
required:
- id
- name
- prefix
- kind
- revoked
- creditsUsed
- balanceCreditsUsed
- dailyCreditsUsed
- calls
additionalProperties: false
description: 'Usage per API key this month, including revoked keys and the console''s own key: their usage is still yours.'
kinds:
type: array
items:
type: object
properties:
kind:
type: string
enum:
- placeFresh
- emailFound
description: 'What the credits paid for: `placeFresh` for new places, `emailFound` for emails.'
creditsUsed:
type: integer
minimum: 0
maximum: 9007199254740991
description: Credits spent this month after refunds, bought ones included.
balanceCreditsUsed:
type: integer
minimum: 0
maximum: 9007199254740991
description: The part of `creditsUsed` paid with bought credits, after refunds.
dailyCreditsUsed:
type: integer
minimum: 0
maximum: 9007199254740991
description: Credits spent today, UTC.
calls:
type: integer
minimum: 0
maximum: 9007199254740991
description: How many times credits were charged, not how many requests were made. A refund doesn't take one back.
required:
- kind
- creditsUsed
- balanceCreditsUsed
- dailyCreditsUsed
- calls
additionalProperties: false
description: This month's usage, split by what the credits paid for.
creditsUsed:
type: integer
minimum: 0
maximum: 9007199254740991
description: Credits spent this month after refunds, bought ones included.
balanceCreditsUsed:
type: integer
minimum: 0
maximum: 9007199254740991
description: The part of `creditsUsed` paid with bought credits, after refunds.
dailyCreditsUsed:
type: integer
minimum: 0
maximum: 9007199254740991
description: Credits spent today, UTC.
calls:
type: integer
minimum: 0
maximum: 9007199254740991
description: How many times credits were charged, not how many requests were made. A refund doesn't take one back.
required:
- plan
- month
- creditsIncluded
- creditBalance
- creditsRemaining
- dailyCreditCap
- resetAt
- dailyResetAt
- keys
- kinds
- creditsUsed
- balanceCreditsUsed
- dailyCreditsUsed
- calls
additionalProperties: false
meta:
anyOf:
- type: object
properties:
total:
type: integer
minimum: 0
maximum: 9007199254740991
description: Every item that matches, not just this page.
limit:
type: integer
exclusiveMinimum: 0
maximum: 9007199254740991
description: The most items a page holds.
offset:
type: integer
minimum: 0
maximum: 9007199254740991
description: How many items came before this page.
hasMore:
type: boolean
description: True when another page follows.
required:
- total
- limit
- offset
- hasMore
additionalProperties: false
- type: object
properties:
cost:
type: integer
minimum: 0
maximum: 9007199254740991
description: Credits this call took.
creditsRemaining:
type: integer
minimum: 0
maximum: 9007199254740991
description: Credits left after this call, this month's and bought ones together.
requestId:
type: string
minLength: 1
description: This call's id. Send it to support if something went wrong.
cached:
description: True when this response used only saved results.
type: boolean
required:
- cost
- creditsRemaining
- requestId
additionalProperties: false
default:
description: Any other failure.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
x-sdk:
method: usage.get
returns: UsageDto
x-mcp-tool: get_usage
servers:
- url: https://api.gmaps.dev/v1
components:
schemas:
ApiError:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
properties:
code:
type: string
enum:
- VALIDATION_ERROR
- UNAUTHORIZED
- INVALID_TOKEN
- PLAN_GATE
- AUP_REQUIRED
- FORBIDDEN
- NOT_FOUND
- PLACE_NOT_FOUND
- COLLECTION_NOT_FOUND
- EXPORT_NOT_FOUND
- CONFLICT
- PAYLOAD_TOO_LARGE
- GEO_UNRESOLVED
- UPSTREAM_BLOCKED
- RATE_LIMIT_EXCEEDED
- QUOTA_EXCEEDED
- INTERNAL_ERROR
- ENGINE_UNAVAILABLE
- SERVICE_UNAVAILABLE
- BILLING_UNAVAILABLE
description: What went wrong, as a word a program can check.
message:
type: string
description: What went wrong, as a sentence.
messageKey:
type: string
description: '`message` as a key, to show it in your reader''s language, with `params` filling its blanks.'
params:
type: object
additionalProperties:
type:
- string
- number
description: The values that fill `messageKey`'s blanks, such as a limit.
details:
description: More about this error, such as retryAfterSecs.
securitySchemes:
apiKey:
type: http
scheme: bearer
description: 'Send your API key as "Authorization: Bearer gm_…".'
x-refined-from:
- openapi.json
- gmaps-dev-openapi.json
x-provenance:
method: harvested
publisher: gmaps.dev
source: https://api.gmaps.dev/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)