> ## 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.

# List Datasources

> Returns datasource configurations the user has access to.



## OpenAPI

````yaml https://data-api-staging.sovfixer.com/api/schema/?format=json get /api/v1/datasources
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,
          "confidence": 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: []
paths:
  /api/v1/datasources:
    get:
      tags:
        - Usage
      summary: List Datasources
      description: Returns datasource configurations the user has access to.
      operationId: api_v1_list_datasources
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDatasourceConfigsResponse'
              examples:
                ListDatasources:
                  value:
                    configs:
                      PG:
                        source_name: Ping Geocoding
                        source_code: PG
                        required_attrs:
                          - address
                        optional_attrs:
                          - const__desc_ping
                          - const__bldg_area
                          - const__num_buildings
                        requires_credentials: false
                        non_supported_input_values: null
                        supported_countries: null
                        supported_us_states: null
                        excluded_us_states: null
                        geocode_confidence_required: null
                        geocode_precision_required: null
                        output_fields:
                          latitude:
                            type: float | None
                            metadata:
                              description: Latitude of the location.
                          longitude:
                            type: float | None
                            metadata:
                              description: Longitude of the location.
                          formatted_address:
                            type: str | None
                            metadata:
                              description: >-
                                Human-readable full address (e.g., '123 Main St,
                                Miami, FL 33133').
                          ...: >-
                            truncated — see every field described on the Data
                            Integrations page
                        base_output_fields:
                          ...: >-
                            truncated — common fields shared across all
                            datasources
                  summary: Response with one datasource config (truncated)
                  description: >-
                    Each key in 'configs' is a source code. Output fields and
                    base output fields are truncated for brevity.
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
          description: ''
      security:
        - tokenAuth: []
components:
  schemas:
    ListDatasourceConfigsResponse:
      type: object
      properties:
        configs:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/DatasourceConfig'
          description: >-
            Object keyed by source code (e.g. 'PG', 'PH'). Each value is the
            datasource's configuration.
      required:
        - configs
    ErrorMessage:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error description.
      required:
        - message
    DatasourceConfig:
      type: object
      properties:
        base_output_fields:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/OutputField'
          description: >-
            Common output fields shared across all datasources (e.g.
            error_message, fetch_time, is_cache_hit).
        excluded_us_states:
          type: array
          items:
            type: string
          nullable: true
          description: >-
            Two-letter US state codes for which this datasource explicitly has
            no data. If set, only US locations are supported.
        geocode_confidence_required:
          type: integer
          nullable: true
          description: >-
            Minimum geocode confidence score required to query this datasource.
            Locations below this threshold are rejected.
        geocode_precision_required:
          type: integer
          nullable: true
          description: >-
            Minimum geocode precision score required to query this datasource.
            Locations below this threshold are rejected.
        optional_attrs:
          type: array
          items:
            type: string
          description: Location attributes that may be supplied but are not required.
        output_fields:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/OutputField'
          description: >-
            Object keyed by field name. Each value describes the field's type
            and metadata. Empty when the datasource has no extract class
            defined.
        required_attrs:
          type: array
          items:
            type: string
          description: Location attributes that must be supplied to query this datasource.
        requires_credentials:
          type: boolean
          description: Whether this datasource requires per-account credentials to query.
        source_code:
          type: string
          description: >-
            Short code for this datasource (e.g., 'PH', 'PG'). Used as the URL
            identifier.
        source_name:
          type: string
          description: Human-readable datasource name.
        supported_countries:
          type: array
          items:
            type: string
          nullable: true
          description: >-
            Two-letter country codes for which this datasource has data. Null
            means no country restriction.
        supported_us_states:
          type: array
          items:
            type: string
          nullable: true
          description: >-
            Two-letter US state codes for which this datasource has data. If
            set, only US locations are supported.
        non_supported_input_values:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          nullable: true
          description: >-
            Mapping of input field name to a list of values this datasource
            cannot process. For example, an occupancy-based datasource may list
            occupancy descriptions it has no data for. Null when the datasource
            accepts all values for its inputs.
      required:
        - base_output_fields
        - excluded_us_states
        - geocode_confidence_required
        - geocode_precision_required
        - optional_attrs
        - output_fields
        - required_attrs
        - requires_credentials
        - source_code
        - source_name
        - supported_countries
        - supported_us_states
    OutputField:
      type: object
      properties:
        type:
          type: string
          description: Python type annotation for this field.
        category:
          type: array
          items:
            type: string
          description: >-
            Hierarchical category path for this field (e.g. ['Risk Data',
            'Hail']).
        description:
          type: string
          description: Human-readable description of this output field.
        display_type:
          type: string
          description: >-
            UI display hint for this field (e.g. 'percentage', 'currency',
            'date').
        return_values:
          description: >-
            Expected value range or format. Either a string (e.g. '0-100') or a
            list of allowed values.
      required:
        - type
  securitySchemes:
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"

````