Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API 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.
openapi: 3.2.0
info:
title: GMaps Lead Finder Agent HTTP Me API
version: '1.0'
description: Agent HTTP API for AI clients and scripts. Auth via Bearer API key (gmf_…). Exactly one keyword per job. Shares a single in-flight job lock with the web app. For Remote MCP setup, see https://gmapsleadfinder.com/docs/agent
servers:
- url: https://gmapsleadfinder.com
tags:
- name: Me
paths:
/api/v1/me:
get:
summary: Current plan and credits
security:
- bearerAuth: []
responses:
'200':
description: Plan and credits snapshot
content:
application/json:
schema:
$ref: '#/components/schemas/MeResponse'
'401':
description: Missing or invalid API key
'403':
description: Plan cannot use agent API
tags:
- Me
operationId: getApiV1Me
x-operation-id-source: derived
components:
schemas:
MeResponse:
type: object
required:
- plan
- creditsLimit
- creditsUsed
- creditsRemaining
properties:
plan:
type: string
creditsLimit:
type: number
creditsUsed:
type: number
creditsRemaining:
type: number
description: Total spendable (subscription remaining + permanent packs)
permanentCredits:
type: number
description: Non-expiring credits from one-time packs
subscriptionCreditsRemaining:
type: number
description: Remaining credits from the active subscription period
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: gmf_…