> ## Documentation Index
> Fetch the complete documentation index at: https://offergrid.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Check whether an address falls inside a market

> Evaluates the market exactly as reseller availability, the catalog and /shop do, and reports the outcome area by area: which include/exclude areas matched, which could not be resolved for the given address (e.g. a serviceability source with no street line), and which use a coverage dimension that is not evaluated yet. Pass at least one of `zipCode`, `city` or `state`. `warnings` explains why a covered address may still surface no offers (market not active, dormant areas).



## OpenAPI

````yaml /openapi/openapi-provider.json get /provider/markets/{id}/coverage
openapi: 3.0.0
info:
  title: OfferGrid API
  description: >-
    **Provider API** - Create and manage service offerings, fulfill orders from
    resellers.


    As a provider, you can:

    - Create and publish service offerings (internet, electricity)

    - Control which resellers can access your offers (all, preferred, or
    selected)

    - View and manage orders from resellers

    - Update order fulfillment status and schedule installations

    - Track order lifecycle from pending to completion
  version: '1.0'
  contact: {}
servers:
  - url: https://api.offergrid.io
    description: Production
security: []
tags:
  - name: provider-offers
    description: 'Provider: Manage your service offerings'
  - name: provider-orders
    description: 'Provider: Fulfill orders from resellers'
  - name: provider-webhooks
    description: 'Provider: Receive order events for your offers'
paths:
  /provider/markets/{id}/coverage:
    get:
      tags:
        - provider-markets
      summary: Check whether an address falls inside a market
      description: >-
        Evaluates the market exactly as reseller availability, the catalog and
        /shop do, and reports the outcome area by area: which include/exclude
        areas matched, which could not be resolved for the given address (e.g. a
        serviceability source with no street line), and which use a coverage
        dimension that is not evaluated yet. Pass at least one of `zipCode`,
        `city` or `state`. `warnings` explains why a covered address may still
        surface no offers (market not active, dormant areas).
      operationId: ProviderMarketsController_checkCoverage
      parameters:
        - name: id
          required: true
          in: path
          schema:
            type: string
        - name: line1
          required: false
          in: query
          description: Street address line 1
          schema:
            example: 1100 Congress Ave
            type: string
        - name: line2
          required: false
          in: query
          description: Unit / suite / apartment
          schema:
            example: Suite 200
            type: string
        - name: city
          required: false
          in: query
          description: City
          schema:
            type: string
            example: Austin
        - name: state
          required: false
          in: query
          description: State / province code
          schema:
            type: string
            example: TX
        - name: zipCode
          required: false
          in: query
          description: ZIP / postal code
          schema:
            type: string
            example: '78701'
        - name: country
          required: false
          in: query
          description: Country code (defaults to US)
          schema:
            type: string
            example: US
      responses:
        '200':
          description: Coverage report for the address
        '400':
          description: No address component supplied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '401':
          description: Missing, malformed, or revoked `x-api-key` header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Valid API key, but your team's role does not grant access to this
            endpoint.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Market not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unexpected server error. Safe to retry idempotent requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - api-key: []
components:
  schemas:
    ValidationErrorResponse:
      type: object
      title: Validation Error
      description: >-
        Returned when request-body validation fails. `message` is an array with
        one entry per failed constraint.
      required:
        - statusCode
        - message
      properties:
        statusCode:
          type: integer
          example: 400
        message:
          type: array
          items:
            type: string
          description: One human-readable message per failed constraint.
          example:
            - name should not be empty
            - >-
              category must be one of the following values: internet,
              electricity
        error:
          type: string
          example: Bad Request
    ErrorResponse:
      type: object
      title: Error
      description: Standard error envelope returned by every 4xx and 5xx response.
      required:
        - statusCode
        - message
      properties:
        statusCode:
          type: integer
          description: HTTP status code, repeated in the body.
          example: 404
        message:
          type: string
          description: Human-readable explanation of what went wrong.
          example: Offer not found
        error:
          type: string
          description: Short, stable name for the status code.
          example: Not Found
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Team API key for authentication. Your team role
        (provider/reseller/hybrid) determines which endpoints you can access.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.