Skip to content

Sites

Exposes FIO Sites data for users, either as whole site data or warehouses. All Sites data requires a FIO API KEY. You will need to have access to the data the user has in FIO in order to access it.

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from fio_wrapper import FIO

fio = FIO(api_key="your_api_key")

# Get users warehouses
user_warehouses = fio.Sites.warehouses(username="PrUn username")

# Get users complete sites data incl. buildings, 
# their condition and repair / reclaimable materials
user_sites = fio.Sites.get(username="PrUn username")

# Get users sites data for specific planet incl. buildings, 
# their condition and repair / reclaimable materials
user_sites = fio.Sites.get_planet(username="PrUn username", planet="Montem")

Endpoints

Access site information from FIO.

Sites

Bases: AbstractSites, AbstractEndpoint

get 

1
get(username, timeout=None)

Gets site data for given username from FIO

Note

FIO API Key Required

Parameters:

Name Type Description Default
username str

Prosperous Universe username

 required
timeout float

Request timeout in seconds. Defaults to None.

 None

Raises:

Type Description
NoSiteData

Username has no site data
NotAuthenticated

Not authenticated or no appropiate permissions

Returns:

Type Description
SiteList

Site | SiteList: Site or List of Sites
Source code in fio_wrapper/endpoints/endpoints_v1/sites.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
@apikey_required
def get(self, username: str, timeout: Optional[float] = None) -> SiteList:
    """Gets site data for given username from FIO

    Note:
        FIO API Key Required

    Args:
        username (str): Prosperous Universe username
        timeout (float, optional): Request timeout in seconds. Defaults to None.

    Raises:
        NoSiteData: Username has no site data
        NotAuthenticated: Not authenticated or no appropiate permissions

    Returns:
        Site | SiteList: Site or List of Sites
    """

    (status, data) = self.adapter.get(
        endpoint=self.urls.sites_get_url(username=username),
        err_codes=[204, 401],
        timeout=timeout,
    )

    if status == 200:
        return SiteList.model_validate(data)

    elif status == 204:
        raise NoSiteData("Username has no site data")
    elif status == 401:
        raise NotAuthenticated("Not authenticated or no appropiate permissions")

get_planet 

1
get_planet(username, planet, timeout=None)

Gets site data for given username and planet from FIO

Note

FIO API Key Required

Parameters:

Name Type Description Default
username str

Prosperous Universe username

 required
planet str

PlanetId, PlanetNaturalId or PlanetName. Defaults to None.

 required
timeout float

Request timeout in seconds. Defaults to None.

 None

Raises:

Type Description
NoSiteData

Username has no site data
NotAuthenticated

Not authenticated or no appropiate permissions

Returns:

Name Type Description
Site Site

Site
Source code in fio_wrapper/endpoints/endpoints_v1/sites.py 
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
@apikey_required
def get_planet(
    self, username: str, planet: str, timeout: Optional[float] = None
) -> Site:
    """Gets site data for given username and planet from FIO

    Note:
        FIO API Key Required

    Args:
        username (str): Prosperous Universe username
        planet (str): PlanetId, PlanetNaturalId or PlanetName. Defaults to None.
        timeout (float, optional): Request timeout in seconds. Defaults to None.

    Raises:
        NoSiteData: Username has no site data
        NotAuthenticated: Not authenticated or no appropiate permissions

    Returns:
        Site: Site
    """

    (status, data) = self.adapter.get(
        endpoint=self.urls.sites_planets_get_planet_url(
            username=username, planet=planet
        ),
        err_codes=[204, 401],
        timeout=timeout,
    )

    if status == 200:
        return Site.model_validate(data)
    elif status == 204:
        raise NoSiteData("Username has no site data")
    elif status == 401:
        raise NotAuthenticated("Not authenticated or no appropiate permissions")

planets 

1
planets(username, timeout=None)

Gets a list of SiteIds from FIO for given username

Note

FIO API Key Required

Parameters:

Name Type Description Default
username str

Prosperous Universe username

 required
timeout float

Request timeout in seconds. Defaults to None.

 None

Raises:

Type Description
NoSiteData

Username has no site data
NotAuthenticated

Not authenticated or no appropiate permissions

Returns:

Type Description
List[str]

List[str]: List of SiteIds
Source code in fio_wrapper/endpoints/endpoints_v1/sites.py 
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
@apikey_required
def planets(self, username: str, timeout: Optional[float] = None) -> List[str]:
    """Gets a list of SiteIds from FIO for given username

    Note:
        FIO API Key Required

    Args:
        username (str): Prosperous Universe username
        timeout (float, optional): Request timeout in seconds. Defaults to None.

    Raises:
        NoSiteData: Username has no site data
        NotAuthenticated: Not authenticated or no appropiate permissions

    Returns:
        List[str]: List of SiteIds
    """
    (status, data) = self.adapter.get(
        endpoint=self.urls.sites_planets_get_url(username=username),
        err_codes=[204, 401],
        timeout=timeout,
    )

    if status == 200:
        return data
    elif status == 204:
        raise NoSiteData("Username has no site data")
    elif status == 401:
        raise NotAuthenticated("Not authenticated or no appropiate permissions")

warehouses 

1
warehouses(username, timeout=None)

Get warehouse data for username from FIO

Note

FIO API Key Required

Parameters:

Name Type Description Default
username str

Prosperous Universe username

 required
timeout float

Request timeout in seconds. Defaults to None.

 None

Raises:

Type Description
NoSiteData

Username has no warehouse site data
NotAuthenticated

Not authenticated or no appropiate permissions

Returns:

Name Type Description
WarehouseList WarehouseList

List of Warehouses
Source code in fio_wrapper/endpoints/endpoints_v1/sites.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
@apikey_required
def warehouses(
    self, username: str, timeout: Optional[float] = None
) -> WarehouseList:
    """Get warehouse data for username from FIO

    Note:
        FIO API Key Required

    Args:
        username (str): Prosperous Universe username
        timeout (float, optional): Request timeout in seconds. Defaults to None.

    Raises:
        NoSiteData: Username has no warehouse site data
        NotAuthenticated: Not authenticated or no appropiate permissions

    Returns:
        WarehouseList: List of Warehouses
    """
    (status, data) = self.adapter.get(
        endpoint=self.urls.sites_warehouses_get(username=username),
        err_codes=[204, 401],
        timeout=timeout,
    )

    if status == 200:
        return WarehouseList.model_validate(data)
    elif status == 204:
        raise NoSiteData("Username has no warehouse site data")
    elif status == 401:
        raise NotAuthenticated("Not authenticated or no appropiate permissions")