> ## Documentation Index
> Fetch the complete documentation index at: https://developers.portao3.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a hotel search as map points

> Returns every hotel of a search as a point to plot on a map.

The list is unpaginated, so the whole result set can be drawn at once. Each point has the hotel's name, its position, the total of the cheapest room found for it and the `itemId` to open its rooms with the search item endpoint. There is one point per hotel — when the same property appears more than once, the cheapest occurrence wins — and hotels with no known position are left out, so the list can be shorter than the search's `totalCount`.

It works on hotel searches only and takes no query parameters. While `status` is `PROCESSING` or `FAILED`, `results` is empty: poll until `status` is `COMPLETED`. Amounts are integers in cents: `125000` is R\$ 1.250,00. An error the travel provider reports about the request is returned with its own status, `code` and `message`.


## OpenAPI

````yaml /api-reference/travel.openapi.json get /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}/map
openapi: 3.0.3
info:
  title: Travel
  version: 1.0.0
  description: >-
    Portão 3 travel API. Every endpoint requires a bearer token in the
    Authorization header (Authorization: Bearer <token>) unless its page states
    otherwise; see the Authentication guide. That requirement is not repeated
    per endpoint. Generated by tools/openapi from code (routes + security) and
    the hand-written spec (request/response bodies). Passenger directory, trips
    and the search proxy (air/hotel/bus/vehicle). Every route validates path,
    query and body through a zod Input class (`travel/src/domain/*/input`),
    which documents its parameters and body; responses are the named interfaces
    in `travel/src/domain/*/response.ts`. Confidence tiers: generated:typed=53
    copied:manual=0 unknown=0.
servers:
  - url: https://api.travel.v2.portao3.com.br/
    description: production
  - url: https://api.travel.dev.3pers.com.br/
    description: development
security: []
tags:
  - name: Passengers
  - name: Trips
  - name: Air search
  - name: Hotel search
  - name: Bus search
  - name: Vehicle search
paths:
  /realms/{realmId}/organizations/{organizationId}/hotel/searches/{searchId}/map:
    get:
      tags:
        - Hotel search
      summary: Get a hotel search as map points
      description: Returns every hotel of a search as a point to plot on a map.
      operationId: >-
        getRealmsByRealmIdOrganizationsByOrganizationIdHotelSearchesBySearchIdMap
      parameters:
        - name: realmId
          in: path
          required: true
          description: |-
            ID of your realm.

            Format: `UUID`
          schema:
            type: string
            format: uuid
          example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b
        - name: organizationId
          in: path
          required: true
          description: |-
            ID of your organization.

            Format: `UUID`
          schema:
            type: string
            format: uuid
          example: c4bd3f21-dfbd-44e8-8055-68ba15bed410
        - name: searchId
          in: path
          required: true
          description: ID of the hotel search, as returned when it was created.
          schema:
            type: string
            pattern: ^srch_[0-9A-Za-z]{21}$
          example: srch_Qm8Zt3LwXc1Ry7NvB0kHd
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - PROCESSING
                      - FAILED
                      - COMPLETED
                    description: >-
                      Status of the search: `PROCESSING`, `COMPLETED` or
                      `FAILED`. `results` is filled only when it is `COMPLETED`.
                    example: COMPLETED
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        itemId:
                          type: string
                          description: >-
                            ID of the search item. Use it to load the hotel's
                            rooms; send it as `searchItemId` when you create a
                            trip.
                          example: srch_item_Zt5Hk2NwQe8Lr3VcXb1Ya
                        hotelId:
                          type: string
                          description: >-
                            ID of the hotel; the same property keeps it across
                            searches.
                          example: htl_Pd4Mx9TgUa6Rj1WnKc3Sv
                        name:
                          type: string
                          description: Name of the hotel.
                          example: Hotel Paulista Plaza
                        cheapestFareAmount:
                          type: number
                          description: >-
                            Total of the cheapest room found for the hotel, in
                            cents (`125000` is R$ 1.250,00).
                          example: 125000
                        cheapestFareCurrency:
                          type: string
                          description: Currency of `cheapestFareAmount` (ISO 4217).
                          example: BRL
                        coordinates:
                          type: object
                          properties:
                            lat:
                              type: number
                              description: Latitude, in decimal degrees.
                              example: -23.4356
                            lng:
                              type: number
                              description: Longitude, in decimal degrees.
                              example: -46.4731
                          required:
                            - lat
                            - lng
                          description: Position of the hotel.
                      required:
                        - itemId
                        - hotelId
                        - name
                        - cheapestFareAmount
                        - cheapestFareCurrency
                        - coordinates
                      description: A hotel on the map of a search.
                    description: >-
                      One point per hotel, with the cheapest room found, in a
                      single unpaginated list. Hotels with no known position are
                      left out, so it can be shorter than the search's
                      `totalCount`. Empty while `status` is `PROCESSING` or
                      `FAILED`.
                required:
                  - status
                  - results
                description: Every hotel of a search that can be placed on a map.
        '404':
          description: >-
            `SEARCH_NOT_FOUND` — The search doesn't exist, has expired, was
            created by another organization or is not a hotel search.
          content:
            application/json:
              schema:
                type: object
                properties:
                  traceId:
                    type: string
                    description: >-
                      Identifier of the request that failed. Quote it when
                      contacting support.
                    example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                  code:
                    type: string
                    enum:
                      - SEARCH_NOT_FOUND
                    description: >-
                      Stable, machine-readable error code. Branch on this, never
                      on `message`.
                  origin:
                    type: string
                    enum:
                      - TRAVEL
                    description: Service that produced the error.
                  message:
                    type: string
                    description: >-
                      Human-readable explanation. Its wording may change without
                      notice.
                required:
                  - traceId
                  - code
                  - origin
                  - message
              example:
                traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                code: SEARCH_NOT_FOUND
                origin: TRAVEL
                message: Search not found
        '422':
          description: >-
            `BAD_REQUEST` — A path parameter is not a valid ID; `fields` lists
            each one.
          content:
            application/json:
              schema:
                type: object
                properties:
                  traceId:
                    type: string
                    description: >-
                      Identifier of the request that failed. Quote it when
                      contacting support.
                    example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                  code:
                    type: string
                    enum:
                      - BAD_REQUEST
                    description: >-
                      Stable, machine-readable error code. Branch on this, never
                      on `message`.
                  origin:
                    type: string
                    enum:
                      - TRAVEL
                    description: Service that produced the error.
                  message:
                    type: string
                    description: >-
                      Human-readable explanation. Its wording may change without
                      notice.
                  fields:
                    type: array
                    description: >-
                      One entry per invalid request field (validation errors
                      only).
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          description: >-
                            Path of the invalid field, e.g. `label` or
                            `values[0].value`.
                          example: label
                        message:
                          type: string
                          description: Why the field was rejected.
                          example: label is required
                        code:
                          type: string
                          description: >-
                            `<FIELD>_<REASON>` — e.g. `LABEL_REQUIRED`,
                            `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`.
                          example: LABEL_REQUIRED
                        values:
                          type: array
                          items:
                            type: string
                          description: >-
                            The accepted values, when the field is an
                            enumeration.
                      required:
                        - field
                        - message
                        - code
                required:
                  - traceId
                  - code
                  - origin
                  - message
              example:
                traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                code: BAD_REQUEST
                origin: TRAVEL
                message: >-
                  Bad Request: Your request is invalid or incomplete. Please
                  make sure you are requesting with the right fields.
                fields:
                  - field: organizationId
                    message: Invalid UUID
                    code: ORGANIZATIONID_UUID
        '503':
          description: >-
            `PROVIDER_UNAVAILABLE` — The travel provider could not be reached.
            Retry later.
          content:
            application/json:
              schema:
                type: object
                properties:
                  traceId:
                    type: string
                    description: >-
                      Identifier of the request that failed. Quote it when
                      contacting support.
                    example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                  code:
                    type: string
                    enum:
                      - PROVIDER_UNAVAILABLE
                    description: >-
                      Stable, machine-readable error code. Branch on this, never
                      on `message`.
                  origin:
                    type: string
                    enum:
                      - TRAVEL
                    description: Service that produced the error.
                  message:
                    type: string
                    description: >-
                      Human-readable explanation. Its wording may change without
                      notice.
                required:
                  - traceId
                  - code
                  - origin
                  - message
              example:
                traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b
                code: PROVIDER_UNAVAILABLE
                origin: TRAVEL
                message: Travel provider temporarily unavailable, please retry.

````

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