Download everything
GET /v1/dump returns every item and every guide in one response.
curl --compressed -o dump.json https://truefloat.app/api/v1/dump--compressed requests a compressed response and decompresses it, so
dump.json is plain JSON. To keep the compressed bytes, send
-H 'Accept-Encoding: gzip' instead. The shape, with the arrays cut:
{ "dataset_version": "e9c25a6", "data": { "items": [ { "def_index": 1, "paint_index": 1054, "slug": "deagle-heat-treated", "weapon": "Desert Eagle", "finish": "Heat Treated", "paint_label": "Heat Treated" }, "..." ], "guides": [ { "steam_id": "2941982575", "title": "AK-47 Case Hardened | Blue Gem", "...": "..." }, "..." ] }}Compression
Section titled “Compression”Served brotli when Accept-Encoding includes br, else gzip when it
includes gzip, else plain. Always ask for compression: the plain dump is
tens of megabytes. Most HTTP clients ask by default; curl needs
--compressed.
The dump is built once per dataset_version and served from memory. In the
first seconds after an API restart, a request can wait a few seconds for
the build.
When to use it
Section titled “When to use it”| you’re building… | use |
|---|---|
| a single item page or listing | GET /v1/items/{def}/{paint}/patterns: one item, every seed |
| every listing on a marketplace page | still /patterns, once per item shown |
| a local mirror, search index, or offline dataset | /v1/dump |
| grades on many items at once, looked up locally (a browser extension) | /v1/index, once per dataset_version |
| “did the dataset change since I last checked” | GET /v1/meta, compare dataset_version |
Conditional re-download
Section titled “Conditional re-download”Send If-None-Match with the ETag you have. A 304 means nothing
changed:
curl --compressed -D - -o dump.json \ -H 'If-None-Match: "e9c25a6"' \ https://truefloat.app/api/v1/dumpHTTP/2 304etag: "e9c25a6"cache-control: public, max-age=3600vary: Accept-Encodingaccess-control-allow-origin: *access-control-expose-headers: ETag, Retry-AfterA 304 has no body, so curl leaves your dump.json untouched.
Every grade in one index: /v1/index
Section titled “Every grade in one index: /v1/index”GET /v1/index is the compact twin of /v1/dump: every graded seed of every
guide, grouped by system and level, without quotes or provenance. Use it to
look seeds up locally across many items.
curl --compressed -o index.json https://truefloat.app/api/v1/indexGuides and topics are listed once, in guides and families. Each system
points at them by array index (guide, family) and lists the items it
grades as [def_index, paint_index] pairs in items. Each level is one
guide’s own level, and levels are listed best first. An excerpt, cut to
one guide’s systems and their topic:
{ "dataset_version": "e9c25a6", "data": { "families": [ { "colours": ["#3b82f6"], "colours_light": ["#3b82f6"], "glyph": "brilliant", "id": "blue-gem", "name": "Blue Gem" } ], "guides": [ { "authors": ["korenevskiy"], "display_sub": "Blue Gem", "steam_id": "2941982575", "title": "AK-47 Case Hardened | Blue Gem" } ], "schema": 1, "systems": [ { "category": "skin", "definition": "The pattern index affects the appearance of the skin as well as its price. Variations of the pattern with a predominance of blue areas on the top of the receiver Blue Top are considered to be the rarest and the most expensive ones. Patterns with a predominance of yellow are more affordable and common.", "display": "Blue Gem", "family": 0, "guide": 0, "items": [[7, 44]], "kind": "tier", "label": "AK-47 Blue Gem", "levels": [ { "caption": [661], "definition": "AK-47 Case Hardened with pattern #661 . It got its name in honour of a small yellow stripe on the side. Look, it’s placed just above the gun’s clip. This is an extremely rare skin.", "key": "top", "label": "#1", "n": 1, "ranked": [[661, 1]], "seeds": [661] }, { "caption": [151, 179, 321, 670, 760, 955], "display": "Tier 1", "key": "1", "label": "Rank 1", "n": 13, "seeds": [ 151, 168, 179, 321, 387, 555, 592, 617, 670, 760, 809, 828, 955 ] }, { "caption": [750], "display": "Tier 2", "key": "2", "label": "Rank 2", "n": 53, "seeds": [ 4, 13, 28, 32, 65, 74, 81, 82, 92, 103, 122, 139, 147, 172, 189, 205, 228, 256, 323, 341, 426, 430, 442, 463, 479, 512, 525, 526, 532, 541, 571, 578, 605, 627, 695, 698, 708, 713, 750, 752, 791, 844, 868, 887, 888, 892, 903, 905, 922, 950, 969, 978, 996 ] }, { "caption": [363], "display": "Tier 3", "key": "3", "label": "Rank 3", "n": 30, "seeds": [ 34, 112, 278, 310, 312, 363, 381, 413, 428, 429, 450, 519, 557, 586, 610, 647, 685, 689, 690, 733, 754, 770, 819, 823, 856, 862, 872, 878, 935, 1000 ] } ] } ] }}| field | meaning |
|---|---|
kind |
the system’s scale.kind, see Levels and scales |
key, label |
the author’s level, as in the full guide response |
n |
how many distinct seeds the level has |
seeds |
the level’s seeds in the order the guide lists them; a seed listed twice is kept twice |
ordered |
true when the guide itself ranks the level’s seeds, see below |
ranked |
[seed, rank] pairs, where the author numbers a seed’s rank |
caption |
the seeds whose evidence is an image caption |
Optional fields (side, definition, caption, ranked, ordered and
others) are left out when empty or unknown, never sent as null. The
reference lists every field.
Guides carry no URL. Link to
https://steamcommunity.com/sharedfiles/filedetails/?id=<steam_id> and show
the title and authors next to every grade (see
Attribution).
schema is 1. Schema 1 only ever gains fields; a breaking change would be
served at ?schema=2, with plain /v1/index staying on schema 1.
Like /v1/dump, it is served brotli or gzip with the same ETag, and
Cache-Control: public, max-age=3600. Fetch it once per dataset_version.
Seeds the guide ranks: ordered
Section titled “Seeds the guide ranks: ordered”A level has ordered: true when the guide says its seeds are ranked, best
first, in list order. seeds is then the author’s ranking. CptnKraken’s
Hand Wraps “Overprint” guide (2772035880) says of each tier it ranks:
“These patterns are ordered from BEST (at the top) to WORST (at the
bottom)”. The flag is copied from the guide, never inferred. Without it,
seeds is only the order of appearance.
A seed the guide lists twice is kept twice, so a seed’s place in an ordered level is its first position among the level’s distinct seeds, counting from 1. That guide’s first “Arrow” tier lists 892 twice:
{ "key": "1", "label": "TIER 1 \"Arrow\" Patterns", "n": 9, "ordered": true, "seeds": [467, 892, 892, 122, 307, 162, 308, 52, 891, 658]}467 is 1st, 892 2nd and 122 3rd of 9: the second 892 takes no place, and
n counts distinct seeds. The full guide response has the same ordered
flag on each level, with its source sentence in ordered_quote (see
Reading a guide response).