Mapping Pins

The Mapping Pins API returns lightweight pin records for a map viewport — coordinates plus the handful of fields a pin needs — so panning and zooming does not cost a full property record per marker.

POST/v2/PropertyMapping

Get map pins

Request attributes

  • Name
    latitude
    Type
    number
    Description

    Latitude of the viewport centre.

  • Name
    longitude
    Type
    number
    Description

    Longitude of the viewport centre.

  • Name
    radius
    Type
    number
    Description

    Radius in miles around the centre point.

  • Name
    city
    Type
    string
    Description

    City, as an alternative to a point and radius.

  • Name
    state
    Type
    string
    Description

    Two-character state code.

  • Name
    county
    Type
    string
    Description

    County.

  • Name
    zip
    Type
    string
    Description

    Five-digit ZIP code.

  • Name
    size
    Type
    integer
    Description

    Number of pins to return.

  • Name
    resultIndex
    Type
    integer
    Description

    Offset to start from.

  • Name
    beds_min
    Type
    integer
    Description

    Minimum bedroom count.

  • Name
    beds_max
    Type
    integer
    Description

    Maximum bedroom count.

  • Name
    baths_min
    Type
    integer
    Description

    Minimum bathroom count.

  • Name
    baths_max
    Type
    integer
    Description

    Maximum bathroom count.

  • Name
    value_min
    Type
    integer
    Description

    Minimum estimated value.

  • Name
    value_max
    Type
    integer
    Description

    Maximum estimated value.

  • Name
    lot_size_min
    Type
    integer
    Description

    Minimum lot size.

  • Name
    building_size_min
    Type
    integer
    Description

    Minimum building size.

  • Name
    mls_active
    Type
    boolean
    Description

    Only properties currently active on the MLS.

Request

POST
/v2/PropertyMapping
curl -X POST https://api.realestateapi.com/v2/PropertyMapping \
  -H "x-api-key: $REALESTATEAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{"latitude": 33.9207, "longitude": -118.3277, "radius": 1, "size": 250}'

Was this page helpful?