Maps

API for navigation and maps.

class artifacts.api.maps.MapsAPI[source]

Bases: object

Map endpoints (public, no auth).

__init__(http)[source]
Parameters:

http (HttpClient)

async get_all(*, layer=None, content_type=None, content_code=None, hide_blocked_maps=None, page=1, size=50)[source]

GET /maps

Return type:

DataPage[MapSchema]

Parameters:
  • layer (MapLayer | None)

  • content_type (MapContentType | None)

  • content_code (str | None)

  • hide_blocked_maps (bool | None)

  • page (int)

  • size (int)

async get_layer(layer, *, content_type=None, content_code=None, hide_blocked_maps=None, page=1, size=50)[source]

GET /maps/{layer}

Return type:

DataPage[MapSchema]

Parameters:
  • layer (MapLayer)

  • content_type (MapContentType | None)

  • content_code (str | None)

  • hide_blocked_maps (bool | None)

  • page (int)

  • size (int)

async get_by_position(layer, x, y)[source]

GET /maps/{layer}/{x}/{y}

Return type:

MapSchema

Parameters:
async get_by_id(map_id)[source]

GET /maps/id/{map_id}

Return type:

MapSchema

Parameters:

map_id (int)