Skip to content

Note

Bases: BaseModel, Bindable

Represents a note on the map

Attributes:

Name Type Description
id int

The ID of the note.

lon float

The longitude of the note in degrees.

lat float

The latitude of the note in degrees.

url HttpUrl

The URL of the note.

comment_url HttpUrl | None

The URL end-point of the API to make a comment.

close_url HttpUrl

The URL end-point of the API to close a note.

date_created datetime

The date and time that the note was created.

comments list[Comment]

A list with all the comments on the note.

geometry property

The geometry of the note

Returns:

Type Description
Point

A point representing the longitude and latitude of the note.

Comment

Bases: BaseModel, Bindable

Represents a comment on a note

User details may be missing if the note was submitted anonymously.

Attributes:

Name Type Description
date datetime

The date and time the comment was created.

uid int | None

The ID of the user that submitted the comment (if present).

user str | None

The display name of the user that submitted the comment (if present).

user_url HttpUrl | None

A URL to the user's page (if present).

action str

The action the user took (opened, closed, commented, etc.) when commenting.

text str

The text of the comment.

html str

The HTML form of the comment.

is_anonymous property

Whether the comment was submitted anonimously or not

fetch_user()

Fetches the user that made the comment

Returns:

Type Description
User | None

User if the the user information is available, otherwise None