Location

Request and retrieve real-time location data via iMessage.

Use these endpoints to request a contact’s location, retrieve location data for contacts who are sharing with you, and subscribe to webhooks when someone starts or stops sharing their location.

Coordinates are returned in GeoJSON format: [longitude, latitude] or [longitude, latitude, altitude] if altitude is available.

Request location sharing

chats.location.request() -> LocationRequestResponse

POST/v3/chats/{chatId}/location/request

Get location data

chats.location.retrieve() -> GetChatLocationResponse

GET/v3/chats/{chatId}/location

ModelsExpand Collapse

class GetChatLocationResponse: …

data: Data

features: List[DataFeature]

geometry: DataFeatureGeometry

coordinates: List[float]

[longitude, latitude] or [longitude, latitude, altitude]

type: Literal["Point"]

properties: DataFeatureProperties

handle: str

Phone number or email of the person sharing their location

address: Optional[str]

Full street address

locality: Optional[str]

City or locality name

updated_at: Optional[datetime]

When the location was last updated

formatdate-time

type: Literal["Feature"]

type: Literal["FeatureCollection"]

success: bool

class LocationRequestResponse: …

message: str

success: bool