> ## Documentation Index > Fetch the complete documentation index at: https://docs.gabin.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get the current account > The account and credential behind the bearer, the plan, the per-minute rate limit and the daily quota with what remains after this call, and today's recorded usage. Useful to check a key. ## OpenAPI ````yaml https://api.gabin.ai/v1/openapi.json get /v1/me openapi: 3.1.0 info: title: Gabin API version: 1.0.0 description: >- French company and real-estate data for builders: companies (SIRENE, RNE), establishments, officers, annual accounts, buildings (BDNB), parcels, addresses, zones, multi-criteria search, vector tiles, reference data. Guides: https://docs.gabin.ai. **Authentication.** Every endpoint except `/v1/health` and `/v1/openapi.json` requires `Authorization: Bearer `: an API key (`gab_live_…`, created at https://gabin.ai/compte/api) or an OAuth access token (`gat_…`, MCP connectors). **Limits (free plan).** 60 weighted requests per minute and 5,000 units per UTC day per account. A request weighs 1 unless its endpoint states otherwise. Every response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset`, `X-Quota-Remaining` and `X-Request-Id`. **Responses.** Success: `{ "data": …, "meta": { … } }`. Lists are paginated by an opaque cursor (`meta.page.next_cursor`, up to 100 per page and 10,000 results per query). Errors: `{ "error": { "code", "message", "docs_url" } }`. Dates are ISO 8601, amounts in euros, areas in m², coordinates WGS84 `[lon, lat]`. **Data rules.** Companies under SIRENE partial diffusion are returned without the person's name, street address, position or building. Officers come from public registers only (name, first names, month and year of birth, mandates), without contact details. No contact data is exposed. contact: name: Gabin url: https://gabin.ai servers: - url: https://api.gabin.ai security: - bearerAuth: [] tags: - name: Companies description: >- Companies (SIRENE legal units): search with filters, profile, establishments, officers, annual accounts. - name: Establishments description: Establishments (SIRENE), by SIRET. - name: Officers description: >- Company officers from public registers (RNE): search by name, mandates, relationships. - name: Reference data description: >- Values accepted by the filters: NAF activities, legal form families, headcount ranges. - name: Account description: 'The account behind the API key: plan, limits, remaining quota.' - name: Meta description: Service status and OpenAPI document. No authentication. - name: Buildings description: >- French buildings (BDNB): profile, linked companies, sections (energy, transactions, owners, condominium, parcels, parking, permits, fiber, planning, market) and geographic search. - name: Parcels description: 'Cadastral parcels: boundary, area, buildings.' - name: Addresses description: >- Address geocoding (Base Adresse Nationale) with the BDNB building at the address, and named places. - name: Zones description: >- Cities, districts (merged IRIS), departments, and market figures of a zone (prices, rents, demography, income). - name: Search description: >- Multi-criteria search on buildings or companies in a zone: a catalog of fields, AND conditions, OR groups. - name: Tiles description: Vector tiles (Mapbox Vector Tile) of the gabin.ai map layers. paths: /v1/me: get: tags: - Account summary: Get the current account description: >- The account and credential behind the bearer, the plan, the per-minute rate limit and the daily quota with what remains after this call, and today's recorded usage. Useful to check a key. operationId: getMe parameters: [] responses: '200': description: OK headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' X-RateLimit-Remaining: $ref: '#/components/headers/X-RateLimit-Remaining' X-RateLimit-Reset: $ref: '#/components/headers/X-RateLimit-Reset' X-Quota-Remaining: $ref: '#/components/headers/X-Quota-Remaining' content: application/json: schema: type: object required: - data - meta properties: data: $ref: '#/components/schemas/Me' meta: type: object description: Empty for a single resource. '401': description: UNAUTHENTICATED headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' content: application/json: schema: $ref: '#/components/schemas/Error' examples: UNAUTHENTICATED: value: error: code: UNAUTHENTICATED message: Invalid or revoked API key. docs_url: https://docs.gabin.ai/errors#unauthenticated '429': description: RATE_LIMITED, QUOTA_EXCEEDED headers: X-Request-Id: $ref: '#/components/headers/X-Request-Id' Retry-After: $ref: '#/components/headers/Retry-After' content: application/json: schema: $ref: '#/components/schemas/Error' examples: RATE_LIMITED: value: error: code: RATE_LIMITED message: >- Rate limit reached (60 weighted requests per minute). Retry in 12 s. docs_url: https://docs.gabin.ai/errors#rate_limited QUOTA_EXCEEDED: value: error: code: QUOTA_EXCEEDED message: >- Daily quota reached (5000 units per UTC day). It resets at 00:00 UTC. docs_url: https://docs.gabin.ai/errors#quota_exceeded components: headers: X-Request-Id: description: Unique id of the request; quote it when contacting support. schema: type: string X-RateLimit-Limit: description: Weighted requests allowed per minute for the account. schema: type: integer X-RateLimit-Remaining: description: Weighted requests left in the current minute. schema: type: integer X-RateLimit-Reset: description: Seconds until the per-minute window resets. schema: type: integer X-Quota-Remaining: description: Units left in the daily quota (UTC day). schema: type: integer Retry-After: description: Seconds to wait before retrying. schema: type: integer schemas: Me: type: object properties: account_id: type: string description: Id of the Gabin account the credential belongs to. credential: type: object properties: type: type: string enum: - api_key - oauth description: >- `api_key`: gab_live_ key. `oauth`: OAuth access token (MCP connectors). id: type: string description: Id of the API key, or of the OAuth client. required: - type - id plan: type: string enum: - free description: Plan of the account. rate_limit: type: object properties: limit: type: number description: Allowance of the window. remaining: type: number description: Units left in the window (rounded down). reset_seconds: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Seconds until the window resets. required: - limit - remaining - reset_seconds description: >- Per-account rate limit: weighted requests per minute (60 on the free plan). A request weighs 1 unless its endpoint says otherwise. quota: type: object properties: limit: type: number description: Allowance of the window. remaining: type: number description: Units left in the window (rounded down). reset_seconds: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Seconds until the window resets. required: - limit - remaining - reset_seconds description: >- Daily quota (UTC day): weighted units per day (5,000 on the free plan). usage_today: anyOf: - type: object properties: requests: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Requests made today (UTC). units: type: number description: Units consumed today (UTC). required: - requests - units - type: 'null' description: >- Usage recorded today across all credentials of the account; null when not available yet. required: - account_id - credential - plan - rate_limit - quota - usage_today description: The account behind the credential, its plan and remaining allowance. Error: type: object properties: error: type: object properties: code: type: string enum: - UNAUTHENTICATED - FORBIDDEN - NOT_FOUND - INVALID - ZONE_REQUIRED - PAGINATION_LIMIT - RATE_LIMITED - QUOTA_EXCEEDED - TIMEOUT - BUSY - INTERNAL description: Stable machine-readable code. message: type: string description: Human-readable explanation, in English. docs_url: type: string description: Documentation page for this error code. required: - code - message - docs_url required: - error description: Error body. The HTTP status matches `error.code`. securitySchemes: bearerAuth: type: http scheme: bearer description: API key `gab_live_…` or OAuth access token `gat_…`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.