Shareable match snippet
get_share_snippetGenerate a ready-to-paste match card snippet plus structured data for a match, team fixture, standings table, bracket, date, or live matches.
Instructions
A polished, copy-pasteable card (plain text) for a match (matchId), a team's next fixture (team), one standings table (group: a table key, e.g. "A", "A1", "A-B" or "LEAGUE"), the knockout bracket (bracket: true), a date (default: today), or live matches (live: true). Returns the ready-to-paste snippet plus structured data: hand the snippet text to the user verbatim. marketComplete:false is stated inside the card as an incomplete optional read; partial (on any match card, live and date included) is stated inside the card too: the provider sent records that could not be used. Off the World Cup a next card names the club resolved, and an empty card says the span searched (horizon, window) or that the competition is between editions. No links; it carries a non-affiliation disclaimer, and any market line stays informational only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tz | No | IANA timezone for kickoff times, e.g. America/Mexico_City | |
| date | No | Date as YYYY-MM-DD (default: today) | |
| lang | No | Locale for dates, list titles, match status and stage words, a match timeline's kind words (Goal, Yellow card…), the empty and outage sentences, provider attribution, and commentary: en, es, pt or fr (no other value is supported). Without it, or when it is empty, the server's CLAUDINHO_LANG when that is exactly one of the four, else en. The market copy, a few notes and the disclaimer stay English | |
| live | No | Snapshot of matches in play right now | |
| team | No | A team name or code for that team's next fixture: a club (Arsenal) or a nation (MEX) | |
| group | No | Table key for a standings card: a group letter (A), or A1, A-B, LEAGUE | |
| style | No | social (default, full card) or compact (one line per match) | |
| flavor | No | Commentary flair: off, subtle, full (default: full) | |
| bracket | No | Knockout bracket card (use with optional knockoutStage) | |
| matchId | No | Match id (most specific) | |
| competition | No | The competition: an alias such as premier-league, or an ESPN slug such as eng.1 (list_competitions lists the aliases). Without it: the server's CLAUDINHO_COMPETITION, else the user's saved choice (claudinho follow); with none, the answer is noCompetition | |
| knockoutStage | No | Filter the bracket card to one round | |
| includeHashtag | No | Include the #VibingLaVidaLoca tag (default true) | |
| includeMarkets | No | Include the reliable market line when available (default true) | |
| includeInstallLine | No | Include the "Try it: …" run cue (default true) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | ||
| team | No | ||
| view | No | ||
| count | No | ||
| group | No | ||
| stage | No | ||
| style | No | ||
| served | No | The shown fixtures whose record the provider's window held; a shown fixture not among them is the bundled schedule's row, its live state unconfirmed | |
| source | No | ||
| tables | No | ||
| target | No | ||
| window | No | Off the World Cup: a whole read of these provider days (YYYY-MM-DD, inclusive) did not hold the match | |
| horizon | No | Off the World Cup: a whole read of this many provider days ahead held no fixture for the team | |
| matches | No | ||
| partial | No | Present when the provider sent records that could not be used: what is returned is what was read, and may not be the whole answer (absence is not elimination). omitted is how many provider records were left out, when known; they may have lain outside what was asked for, so the count is a bound, not a loss | |
| snippet | No | ||
| degraded | No | ||
| truncated | No | ||
| candidates | No | A next card for a name two or more teams match: them, and no fixture is picked | |
| competition | No | The competition this answer is for: its ESPN slug, its alias, its name, where the choice came from (flag: the competition argument; env: the server's CLAUDINHO_COMPETITION; saved: the user's saved choice, claudinho follow), and experimental for a slug the supported table does not hold; null with noCompetition when nothing is chosen | |
| unknownTeam | No | Present (true) when the roster the competition has holds no team by that name: the bundled nations on the World Cup; the table read whole and the next 14 days' fixtures elsewhere (a claim about that evidence, not the whole competition: a club out in a qualifying round is in no table). Never stated when the table or the span could not be read whole | |
| unsupported | No | Present (true) when this is not available for this competition yet; an empty result then means "unsupported", not "none found" | |
| inapplicable | No | Present (true) when this competition has no such thing at all (a league season with no knockout tie has no knockout tree) | |
| marketSignals | No | ||
| noCompetition | No | Present (true) when no competition is chosen (no competition argument, no server CLAUDINHO_COMPETITION, no saved choice): nothing was read, competition is null, and the text says what to do (pass competition, or the user runs claudinho follow <alias>) | |
| marketComplete | No | False when optional market enrichment did not check every relevant fixture | |
| rosterEvidence | No | With unknownTeam: the evidence it rests on, the competition's table and span (table) or the World Cup's bundled nations (bundle) | |
| betweenEditions | No | Present when the competition is between editions: the edition named by label ended on ended (the provider's calendar day, YYYY-MM-DD, the season end it states), and nothing in the read is scheduled or in play | |
| rosterIncomplete | No | Present (true) when the competition's roster could not be read whole and the name could not be resolved without it (no match, or only by a code or a partial name); not an outage: ask with the club's full name | |
| informationalOnly | No | ||
| responseTruncated | No | ||
| responseTruncation | No |