Muh: /* Authentication, Rate Limits, and Compression */

2026-04-12T06:01:18Z

Authentication, Rate Limits, and Compression

← Older revision		Revision as of 06:01, 12 April 2026
Line 120:		Line 120:
	* <code>MarketDbCache.ApiCacheSeconds = 300</code> (5 minutes)		* <code>MarketDbCache.ApiCacheSeconds = 300</code> (5 minutes)

	== ~~Authentication,~~ Rate Limits~~, and Compression~~ ==		== Rate Limits ==

	=== Rate Limiting ===		=== Rate Limiting ===

Muh: /* Authentication, Rate Limits, and Compression */

2026-04-12T06:01:08Z

Authentication, Rate Limits, and Compression

← Older revision		Revision as of 06:01, 12 April 2026
Line 124:		Line 124:
	=== Rate Limiting ===		=== Rate Limiting ===

	~~Simple per-IP rate limiting is controlled by <code>MarketDbCache.ApiRatePerMinute</code>.~~

	~~Default setting:~~
	* <code>120</code> requests per minute		* <code>120</code> requests per minute

	~~=== Gzip Compression ===~~

	~~If <code>MarketDbCache.ApiEnableGzip</code> is enabled and the client sends <code>Accept-Encoding: gzip</code>, the API returns a gzipped response body.~~

	== Status Codes ==		== Status Codes ==

Muh: Created page with "== MarketDB API == The MarketDB API serves pre-generated JSON snapshot files for vending, buying and trend data. This endpoint is snapshot-based: * API requests do ''not'' execute live database queries. * Responses are served from JSON files which are usually refreshed every 5 minutes. == Endpoint == Typical request format:

 https://flux.muhro.eu/?module=marketdb&action=api&name=<dataset>

== Query Parameters == {| class="wikitable" ! Parameter !..."

2026-04-12T06:00:01Z

Created page with "== MarketDB API == The MarketDB API serves pre-generated JSON snapshot files for vending, buying and trend data. This endpoint is snapshot-based: * API requests do ''not'' execute live database queries. * Responses are served from JSON files which are usually refreshed every 5 minutes. == Endpoint == Typical request format: <pre> https://flux.muhro.eu/?module=marketdb&action=api&name=<dataset> </pre> == Query Parameters == {| class="wikitable" ! Parameter !..."

New page

== MarketDB API ==

The MarketDB API serves pre-generated JSON snapshot files for vending, buying and trend data.

This endpoint is snapshot-based:
* API requests do ''not'' execute live database queries.
* Responses are served from JSON files which are usually refreshed every 5 minutes.

== Endpoint ==

Typical request format:

<pre>
https://flux.muhro.eu/?module=marketdb&action=api&name=<dataset>
</pre>

== Query Parameters ==

{| class="wikitable"
! Parameter
! Required
! Description
|-
| <code>name</code>
| Yes
| Dataset to fetch.
|-
| <code>key</code>
| No
| currently not used
|}

== Available Datasets ==

{| class="wikitable"
! Dataset
! Description
! Notes
|-
| <code>vendings</code>
| Current vendor shop list.
| Shop-level snapshot.
|-
| <code>v_vending</code>
| Items currently for sale.
| Full rows from the vending cache view.
|-
| <code>v_buying</code>
| Items currently being bought.
| Full rows from the buying cache view.
|-
| <code>buyingstores</code>
| Current buying shop list.
| Shop-level snapshot.
|-
| <code>vending_trend_daily</code>
| Full daily sales trend dataset.
| Includes all available day buckets and items.
|-
| <code>vending_trend_hourly</code>
| Full hourly sales trend dataset.
| Includes all available hour buckets and items.
|-
| <code>vending_last_sales</code>
| Latest sales log snapshot.
| Currently limited to 1000 rows.
|-
| <code>vending_trend_daily_latest</code>
| Rolling summary for the last 24 hours.
| Ordered by <code>sales_count</code> descending.
|-
| <code>vending_trend_hourly_latest</code>
| Rolling summary for the last 60 minutes.
| Ordered by <code>sales_count</code> descending.
|-
| <code>vending_last_sales_latest</code>
| Latest sales feed.
| Currently the same 1000-row payload as <code>vending_last_sales</code>.
|-
| <code>meta</code>
| Snapshot metadata.
| Includes <code>generated_at</code> and <code>server</code>.
|}

== Example Requests ==

<pre>
https://flux.muhro.eu/?module=marketdb&action=api&name=vendings
https://flux.muhro.eu/?module=marketdb&action=api&name=v_vending
https://flux.muhro.eu/?module=marketdb&action=api&name=v_buying
https://flux.muhro.eu/?module=marketdb&action=api&name=buyingstores
https://flux.muhro.eu/?module=marketdb&action=api&name=vending_trend_daily_latest
https://flux.muhro.eu/?module=marketdb&action=api&name=vending_trend_hourly_latest
https://flux.muhro.eu/?module=marketdb&action=api&name=vending_last_sales_latest
</pre>

== Response Headers ==

{| class="wikitable"
! Header
! Description
|-
| <code>Content-Type</code>
| <code>application/json; charset=utf-8</code>
|-
| <code>Cache-Control</code>
| Public cache header with <code>max-age</code> from <code>MarketDbCache.ApiCacheSeconds</code>.
|-
| <code>ETag</code>
| Entity tag based on the snapshot file and modification time.
|-
| <code>Last-Modified</code>
| Snapshot file modification timestamp in GMT.
|-
| <code>Content-Encoding</code>
| Set to <code>gzip</code> when gzip is enabled and supported by the client.
|}

Default cache TTL:
* <code>MarketDbCache.ApiCacheSeconds = 300</code> (5 minutes)

== Authentication, Rate Limits, and Compression ==

=== Rate Limiting ===

Simple per-IP rate limiting is controlled by <code>MarketDbCache.ApiRatePerMinute</code>.

Default setting:
* <code>120</code> requests per minute

=== Gzip Compression ===

If <code>MarketDbCache.ApiEnableGzip</code> is enabled and the client sends <code>Accept-Encoding: gzip</code>, the API returns a gzipped response body.

== Status Codes ==

{| class="wikitable"
! Status
! Meaning
|-
| <code>200</code>
| Snapshot returned successfully.
|-
| <code>304</code>
| The client cache is still valid for the current <code>ETag</code>.
|-
| <code>403</code>
| Invalid or missing API key when key protection is enabled.
|-
| <code>404</code>
| Unknown dataset name or snapshot file missing.
|-
| <code>429</code>
| Rate limit exceeded.
|-
| <code>500</code>
| MarketDb cache configuration is missing.
|}

MarketDB API - Revision history

Muh: /* Authentication, Rate Limits, and Compression */

Muh: /* Authentication, Rate Limits, and Compression */