Skip to content

Commit be6bb86

Browse files
committed
Updating Readme.md to include public offer text and example. #20693
1 parent 8f16bd1 commit be6bb86

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -310,6 +310,56 @@ Period Range
310310
.InRelativePeriodRange(Period.FromWeeks(2), Period.FromDays(20))
311311
```
312312

313+
314+
### GME Public Offer
315+
316+
Artesian supports querying GME Public Offers which come in a custom and dedicated format.
317+
318+
Performance note:
319+
GME Public Offer data is partitioned by date, offerType, status, and market. Requesting very narrow subsets (for example a single status or offerType in several separate requests) does not improve performance and can cause the same file to be fetched multiple times.
320+
For this reason:
321+
Use a large page size so that all data for a given (date, market, filters) is typically returned in a single page.
322+
Loop over markets explicitly to cover all required markets without redundant fetches.
323+
324+
### Extract GME Public Offer
325+
const int PAGE_SIZE = 250000;
326+
327+
/* your Artesian configuration */;
328+
329+
var _cfg = new ArtesianServiceConfig(
330+
new Uri("https://arkive.artesian.cloud/{TENANT_NAME}/"),
331+
your_API_Key);
332+
333+
var poService = new GMEPublicOfferService(_cfg);
334+
335+
# List of markets to cover. Extend as needed for your use case.
336+
var markets = new Market[]
337+
{
338+
Market.MGP,
339+
# Market.MSD,
340+
# Market.MIA1
341+
};
342+
343+
344+
var gmePoResults = await poService.CreateRawCurveQuery()
345+
.ForDate(new LocalDate(2025, 11, 1))
346+
.ForStatus(Status.ACC)
347+
.ForPurpose(Purpose.BID)
348+
.ForMarket(markets)
349+
.WithPagination(1, PAGE_SIZE)
350+
.ExecuteAsync();
351+
352+
Console.WriteLine($"Total offers fetched: {allData.Count}");
353+
354+
To construct a GME Public Offer Extraction the following must be provided.
355+
356+
<table>
357+
<tr><th>GME Public Offer Query</th><th>Description</th></tr>
358+
<tr><td>Time Extraction Window</td><td>An extraction time window for data to be queried</td></tr>
359+
<tr><td>Status</td><td>Provide a status to query</td></tr>
360+
<tr><td>Purpose</td><td>Provide a purpose or set of purposes to query</td></tr>
361+
</table>
362+
313363
### Unit of Measure Conversion Functionality
314364

315365
### Overview

0 commit comments

Comments
 (0)