Skip to content

LocalMarket

Access local market information from FIO.

LocalMarket

Bases: AbstractLocalMarket, AbstractEndpoint

planet 

1
planet(planet, timeout=None)

Gets local market ads for planet

Parameters:

Name Type Description Default
planet str

PlanetId, PlanetNaturalId, PlanetName

 required
timeout float

Request timeout in seconds. Defaults to None.

 None

Raises:

Type Description
PlanetNotFound

Planet not found

Returns:

Name Type Description
LocalMarketAds LocalMarketAds

List of ads
Source code in fio_wrapper/endpoints/endpoints_v1/localmarket.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
def planet(self, planet: str, timeout: Optional[float] = None) -> LocalMarketAds:
    """Gets local market ads for planet

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

    Raises:
        PlanetNotFound: Planet not found

    Returns:
        LocalMarketAds: List of ads
    """
    (status, data) = self.adapter.get(
        endpoint=self.urls.localmarket_planet_url(planet),
        err_codes=[204],
        timeout=timeout,
    )

    if status == 200:
        return LocalMarketAds.model_validate(data)
    elif status == 204:
        raise PlanetNotFound("Planet not found")

planet_buy 

1
planet_buy(planet, timeout=None)

Gets all BUY ads from the planets local market

Parameters:

Name Type Description Default
planet str

PlanetId, PlanetNaturalId, PlanetName

 required
timeout float

Request timeout in seconds. Defaults to None.

 None

Raises:

Type Description
PlanetOrAdsNotFound

Planet not found or no ads

Returns:

Name Type Description
LocalMarketAdList LocalMarketAdList

List of planet local market BUY ads
Source code in fio_wrapper/endpoints/endpoints_v1/localmarket.py 
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
def planet_buy(
    self, planet: str, timeout: Optional[float] = None
) -> LocalMarketAdList:
    """Gets all BUY ads from the planets local market

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

    Raises:
        PlanetOrAdsNotFound: Planet not found or no ads

    Returns:
        LocalMarketAdList: List of planet local market BUY ads
    """
    (status, data) = self._planet_type(planet=planet, adtype="BUY", timeout=timeout)

    if status == 200:
        return LocalMarketAdList.model_validate(data)
    elif status == 204:
        raise PlanetOrAdsNotFound("Planet not found or no ads on planet")

planet_sell 

1
planet_sell(planet, timeout=None)

Gets all SELL ads from planets local market

Parameters:

Name Type Description Default
planet str

PlanetId, PlanetNaturalId, PlanetName

 required
timeout float

Request timeout in seconds. Defaults to None.

 None

Raises:

Type Description
PlanetOrAdsNotFound

Planet not found or no ads

Returns:

Name Type Description
LocalMarketAdList LocalMarketAdList

List of planet local market SELL ads
Source code in fio_wrapper/endpoints/endpoints_v1/localmarket.py 
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def planet_sell(
    self, planet: str, timeout: Optional[float] = None
) -> LocalMarketAdList:
    """Gets all SELL ads from planets local market

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

    Raises:
        PlanetOrAdsNotFound: Planet not found or no ads

    Returns:
        LocalMarketAdList: List of planet local market SELL ads
    """
    (status, data) = self._planet_type(
        planet=planet, adtype="SELL", timeout=timeout
    )

    if status == 200:
        return LocalMarketAdList.model_validate(data)
    elif status == 204:
        raise PlanetOrAdsNotFound("Planet not found or no ads on planet")

planet_shipping 

1
planet_shipping(planet, timeout=None)

Gets a list of planets shipping ads

Parameters:

Name Type Description Default
planet str

PlanetId, PlanetNaturalId, PlanetName

 required
timeout float

Request timeout in seconds. Defaults to None.

 None

Raises:

Type Description
PlanetOrAdsNotFound

Planet not found or no ads

Returns:

Name Type Description
LocalMarketShippingAdList LocalMarketShippingAdList

List of planet local market SHIPPING ads
Source code in fio_wrapper/endpoints/endpoints_v1/localmarket.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def planet_shipping(
    self, planet: str, timeout: Optional[float] = None
) -> LocalMarketShippingAdList:
    """Gets a list of planets shipping ads

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

    Raises:
        PlanetOrAdsNotFound: Planet not found or no ads

    Returns:
        LocalMarketShippingAdList: List of planet local market SHIPPING ads
    """
    (status, data) = self._planet_type(
        planet=planet, adtype="SHIP", timeout=timeout
    )

    if status == 200:
        return LocalMarketShippingAdList.model_validate(data)
    elif status == 204:
        raise PlanetOrAdsNotFound("Planet not found or no ads on planet")

shipping_from 

1
shipping_from(planet, timeout=None)

Gets a list of SHIPPING ads starting from planet

Parameters:

Name Type Description Default
planet str

PlanetId, PlanetNaturalId, PlanetName

 required
timeout float

Request timeout in seconds. Defaults to None.

 None

Raises:

Type Description
PlanetOrAdsNotFound

Planet not found or no ads

Returns:

Name Type Description
LocalMarketShippingAdList LocalMarketShippingAdList

List of shipping ads from planet
Source code in fio_wrapper/endpoints/endpoints_v1/localmarket.py 
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
def shipping_from(
    self, planet: str, timeout: Optional[float] = None
) -> LocalMarketShippingAdList:
    """Gets a list of SHIPPING ads starting from planet

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

    Raises:
        PlanetOrAdsNotFound: Planet not found or no ads

    Returns:
        LocalMarketShippingAdList: List of shipping ads from planet
    """
    (status, data) = self.adapter.get(
        endpoint=self.urls.localmarket_shipping_source_url(planet=planet),
        err_codes=[204],
        timeout=timeout,
    )

    if status == 200:
        return LocalMarketShippingAdList.model_validate(data)
    elif status == 204:
        raise PlanetOrAdsNotFound("Planet not found or no ads on planet")

shipping_to 

1
shipping_to(planet, timeout=None)

Gets a list of SHIPPING ads ending at planet

Parameters:

Name Type Description Default
planet str

PlanetId, PlanetNaturalId, PlanetName

 required
timeout float

Request timeout in seconds. Defaults to None.

 None

Raises:

Type Description
PlanetOrAdsNotFound

Planet not found or no ads

Returns:

Name Type Description
LocalMarketShippingAdList LocalMarketShippingAdList

List of shipping ads to planet
Source code in fio_wrapper/endpoints/endpoints_v1/localmarket.py 
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
def shipping_to(
    self, planet: str, timeout: Optional[float] = None
) -> LocalMarketShippingAdList:
    """Gets a list of SHIPPING ads ending at planet

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

    Raises:
        PlanetOrAdsNotFound: Planet not found or no ads

    Returns:
        LocalMarketShippingAdList: List of shipping ads to planet
    """
    (status, data) = self.adapter.get(
        endpoint=self.urls.localmarket_shipping_destination_url(planet=planet),
        err_codes=[204],
        timeout=timeout,
    )

    if status == 200:
        return LocalMarketShippingAdList.model_validate(data)
    elif status == 204:
        raise PlanetOrAdsNotFound("Planet not found or no ads on planet")

company 

1
company(companycode, timeout=None)

Gets a list of all ads of the specified company

Parameters:

Name Type Description Default
companycode str

Company Code (e.g., "SKYP")

 required
timeout float

Request timeout in seconds. Defaults to None.

 None

Raises:

Type Description
CompanyOrAdsNotFound

Company not found or company has no ads

Returns:

Name Type Description
LocalMarketAds LocalMarketAds

List of local market ads of company
Source code in fio_wrapper/endpoints/endpoints_v1/localmarket.py 
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
def company(
    self, companycode: str, timeout: Optional[float] = None
) -> LocalMarketAds:
    """Gets a list of all ads of the specified company

    Args:
        companycode (str): Company Code (e.g., "SKYP")
        timeout (float, optional): Request timeout in seconds. Defaults to None.

    Raises:
        CompanyOrAdsNotFound: Company not found or company has no ads

    Returns:
        LocalMarketAds: List of local market ads of company
    """
    (status, data) = self.adapter.get(
        endpoint=self.urls.localmarket_company_url(companycode=companycode),
        err_codes=[204],
        timeout=timeout,
    )

    if status == 200:
        return LocalMarketAds.model_validate(data)
    elif status == 204:
        raise CompanyOrAdsNotFound("Company not found or no ads from company")