Unwired Labs (incl. OpenCelliD) SEARCH API

openapi: 3.2.0
info:
  version: 2.0.0
  title: Location SEARCH API
  description: Geolocation, Geocoding and Maps
servers:
- url: https://us1.unwiredlabs.com/v2
tags:
- name: SEARCH
paths:
  /search.php:
    get:
      operationId: search
      summary: Forward Geocoding
      tags:
      - SEARCH
      description: The Search API allows converting addresses, such as a street address, into geographic coordinates (latitude and longitude). These coordinates can serve various use-cases, from placing markers on a map to helping algorithms determine nearby bus stops. This process is also known as Forward Geocoding.
      parameters:
      - name: q
        in: query
        description: Address to geocode
        required: true
        schema:
          type: string
        example: '"Statue of Liberty"'
      - name: viewbox
        in: query
        description: 'The preferred area to find search results.  To restrict results to those within the viewbox, use along with the bounded option. Tuple of 4 floats. Any two corner points of the box - `max_lon,max_lat,min_lon,min_lat` or `min_lon,min_lat,max_lon,max_lat` - are accepted in any order as long as they span a real box. '
        required: false
        example: '"-132.84908,47.69382,-70.44674,30.82531"'
        schema:
          type: string
      - name: limit
        in: query
        description: Limit the number of returned results. Default is 10.
        required: false
        example: 10
        schema:
          type: integer
          format: int64
          default: 10
      - name: accept-language
        in: query
        description: Preferred language order for showing search results, overrides the value specified in the Accept-Language HTTP header. Defaults to en. To use native language for the response when available, use accept-language=native
        required: false
        example: '"en"'
        schema:
          type: string
      - name: countrycodes
        in: query
        description: Limit search to a list of countries.
        required: false
        example: '"us"'
        schema:
          type: string
      responses:
        '200':
          description: The response will be a JSON object as defined in the model.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/search_response_schema'
                - $ref: '#/components/schemas/error_schema'
      security:
      - token: []
components:
  schemas:
    status_schema:
      title: status
      description: If the request is successful, ok is returned. Otherwise error is returned
      type: string
      example: '"error"'
    search_response_schema:
      title: Search Response
      type: object
      properties:
        status:
          $ref: '#/components/schemas/status_schema'
        balance:
          description: Balance left in the account
          type: number
          example: 0
        addresses:
          description: Array of Address objects found for the search query
          type: array
          items:
            $ref: '#/components/schemas/address_schema'
    address_schema:
      title: address
      description: Address object found for the search query
      type: object
      properties:
        lat:
          type: string
          description: Latitude of the given location (decimal)
          example: '"41.3438648"'
        lon:
          type: string
          description: Longitude of the given location (decimal)
          example: '"-86.3111653"'
        display_name:
          type: string
          description: Matched Address name for the given location
          example: '"Southpark Lane, Littleton,Arapahoe county, colorado, 800"'
        house_number:
          type: string
          description: House Number
        road:
          type: string
          description: Road Name
          example: '"Southpark Lane"'
        neighborhood:
          type: string
          description: Neighbourhood
        suburb:
          type: string
          description: Suburb
        city:
          type: string
          description: City name (normalized form of city, town, village, hamlet)
          example: '"Denver-Aurora-Lakewood"'
        county:
          type: string
          description: County name (normalized form of county, state_district)
        country:
          type: string
          description: Country name
          example: '"United States of america"'
        country_code:
          type: string
          description: Country code
          example: '"US"'
        postal_code:
          type: string
          description: Postal code
          example: '"80120"'
    error_schema:
      title: error
      type: object
      properties:
        status:
          $ref: '#/components/schemas/status_schema'
        message:
          $ref: '#/components/schemas/message_schema'
    message_schema:
      type: string
      description: Any additional information from the server is returned here
      example: '"INVALID_TOKEN"'
  securitySchemes:
    token:
      name: token
      type: apiKey
      in: query