> ## Documentation Index > Fetch the complete documentation index at: https://docs.pingintel.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Usage Limits > Return the sources your API requests may use, what each costs, and how much of your limits remains. Check it before a large request to see whether the request will fit. A request that doesn't fit is rejected whole: HTTP 403 for an unavailable source, HTTP 429 for exceeding credits or a source's location cap. Usage counts include requests still in progress. ## OpenAPI ````yaml https://data-api.sovfixer.com/api/schema/?format=json get /api/v1/limits openapi: 3.0.3 info: title: Ping.Data API version: v1.0 description: > ### Ping.Data API This API provides convenient, efficient access to bulk location data from many sources. The typical usage flow is: * POST to `/api/v1/bulk_enhance`. The POST body should look like this: ``` { "locations": [ { "id": "user-id1", "address": "1212 Ping Data Lane, Pingville, FL", "sources": ["PG", "PH"], ... }, ... ], "timeout": 60.0, } ``` * Poll GET `/api/v1/bulk_enhance/{id}`, passing the `id` given by the previous response until `response.request.status` is `COMPLETE` or `FAILED`. * Download the data as JSON from `/api/v1/sov/{id}/output/{filename}`. The exact url comes from the response to the above query, in `response.result.outputs[].url`. Output JSON Example: ``` { "user-id1": { "GG": { "is_success": true, "error_message": null, "confidence": 80, "status_code": 200, "fetch_time": 4.754, "street_number": "1212", "route": "Ping Data Ln", "location_type": "ROOFTOP", "latitude": 28.xxx, "longitude": -81.xxx, "formatted_address": "1212 Ping Data Lane, Pingville, FL, USA", "place_id": "xxx-yyy", "address_line_1": "1212 Ping Data Lane", "address_line_2": "", "city": "Pingville", "postal_code": "00010", "county": "Pingville", "state": "FL", "country": "US" }, "HH": { "is_success": true, "error_message": null, "status_code": null, "latitude": 28.xxx, "longitude": -81.xxx, "geocode_type": "ADDRESS", "google_maps_link": "https://www.google.com/maps/search/?api=1&query=28.xxx,-81.xxx", "fema_flood_zone": "X", "elevation": null, "bldg_year_built": 2009, ... more attributes ... } }, ... more buildings ... } ``` contact: email: support@pingintel.com name: Ping Intel url: https://www.pingintel.com servers: - url: https://data-api.sovfixer.com description: Ping.Data API - url: https://data-api-staging.sovfixer.com description: Ping.Data API (staging) security: [] tags: - name: Enhance - name: Bulk Enhance - name: Reference Data description: >- The Reference Data API lists the data sources you can request and their configuration, including the source codes to pass to Enhance and Bulk Enhance. - name: Account description: >- The Account API reports on your account: which sources you may call, your remaining limits, and your API credit usage over time. paths: /api/v1/limits: get: tags: - Account summary: Get Usage Limits description: >- Return the sources your API requests may use, what each costs, and how much of your limits remains. Check it before a large request to see whether the request will fit. A request that doesn't fit is rejected whole: HTTP 403 for an unavailable source, HTTP 429 for exceeding credits or a source's location cap. Usage counts include requests still in progress. operationId: api_v1_limits parameters: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/LimitsResponse' examples: UserOnAPlanWithPay-as-you-go: value: scope: user subject: alice@example.com all_sources: false sources: GG: credits_per_location: 0 HH: credits_per_location: 0 PH: credits_per_location: 50 TD: credits_per_location: 0 credits: start: '2026-09-14T17:02:11+00:00' resets_at: '2026-10-14T17:02:11+00:00' included: 200 payg: 500 used: 312 remaining: 388 summary: User on a plan with pay-as-you-go EnterpriseUserWithALocationCap: value: scope: user subject: bob@example.com all_sources: true sources: LBGR: credits_per_location: 0 locations_remaining: monthly: 88 credits: null summary: Enterprise user with a location cap description: '' '400': content: application/json: schema: $ref: '#/components/schemas/LimitsErrorResponse' description: Both `username` and `org_short_name` were given. '401': content: application/json: schema: $ref: '#/components/schemas/LimitsErrorResponse401' description: '' '403': content: application/json: schema: $ref: '#/components/schemas/LimitsErrorResponse403' description: Querying another user or an organization without Ping staff access. '404': content: application/json: schema: $ref: '#/components/schemas/LimitsErrorResponse404' description: No such user or organization. security: - tokenAuth: [] components: schemas: LimitsResponse: type: object properties: all_sources: type: boolean description: >- True when every source is available. `sources` then lists only the sources that cost credits or have a location cap; any other source is free and uncapped. credits: allOf: - $ref: '#/components/schemas/LimitsCredits' nullable: true description: Credit allowance. Null when requests have no credit limit. scope: enum: - user - org type: string x-spec-enum-id: 807db6603926e4bc description: '`user` for a user''s limits, `org` for an organization''s.' sources: type: object additionalProperties: $ref: '#/components/schemas/LimitsSource' description: >- Available sources by source code. When `all_sources` is false, only these sources can be requested. subject: type: string description: Username, or organization short name when `scope` is `org`. required: - all_sources - credits - scope - sources - subject LimitsErrorResponse: type: object properties: message: type: string required: - message LimitsErrorResponse401: type: object properties: message: type: string required: - message LimitsErrorResponse403: type: object properties: message: type: string required: - message LimitsErrorResponse404: type: object properties: message: type: string required: - message LimitsCredits: type: object properties: included: type: integer description: Credits included in the period. payg: type: integer description: Pay-as-you-go credits allowed beyond `included`. remaining: type: integer description: 'Credits left: `included + payg - used`, never below 0.' resets_at: type: string format: date-time description: When the credit period ends and `used` resets. start: type: string format: date-time description: When the current credit period started. used: type: integer description: Credits used in the period. required: - included - payg - remaining - resets_at - start - used LimitsSource: type: object properties: credits_per_location: type: integer description: >- Credits charged per requested location. A composite source such as `PH` is priced as one source, not by its components. locations_remaining: allOf: - $ref: '#/components/schemas/LimitsLocationsRemaining' description: Present only when the source has a location cap. required: - credits_per_location LimitsLocationsRemaining: type: object properties: daily: type: integer description: Locations left today. Resets at 00:00 UTC. monthly: type: integer description: Locations left this month. Resets on the 1st, 00:00 UTC. securitySchemes: tokenAuth: type: apiKey in: header name: Authorization description: Token-based authentication with required prefix "Token" ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.