@ufcalendar/sdk 0.8.2 → 0.8.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/index.cjs +4 -4
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +110 -81
- package/dist/index.d.ts +110 -81
- package/dist/index.js +4 -4
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1171,11 +1171,13 @@ interface Plan {
|
|
|
1171
1171
|
interface Plans {
|
|
1172
1172
|
currency: string;
|
|
1173
1173
|
plans: Plan[];
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1174
|
+
/** The permanent free plan (2026-10-29): 1,000 requests a month, no card, never expires. */
|
|
1175
|
+
free_plan: {
|
|
1176
|
+
requests_per_month: number;
|
|
1177
|
+
rpm: number;
|
|
1178
|
+
key_limit: number;
|
|
1177
1179
|
card_required: boolean;
|
|
1178
|
-
|
|
1180
|
+
expires: boolean;
|
|
1179
1181
|
start_url: string;
|
|
1180
1182
|
};
|
|
1181
1183
|
mcp: {
|
|
@@ -1377,7 +1379,7 @@ declare class FightAPI {
|
|
|
1377
1379
|
/** Raw GET returning the whole `{data, meta}` envelope. */
|
|
1378
1380
|
getWithMeta<T = unknown>(path: string, params?: Query): Promise<Envelope<T>>;
|
|
1379
1381
|
/**
|
|
1380
|
-
* Plans, quotas, the free
|
|
1382
|
+
* Plans (Free first), quotas, the free-plan rule, the MCP endpoint and the doc
|
|
1381
1383
|
* links. The only endpoint that answers without a credential.
|
|
1382
1384
|
*/
|
|
1383
1385
|
plans(): Promise<Plans>;
|
|
@@ -1738,7 +1740,7 @@ declare class FightAPI {
|
|
|
1738
1740
|
|
|
1739
1741
|
/** Kept in lockstep with package.json and the User-Agent by
|
|
1740
1742
|
* `apps/api/src/surfaces.test.ts`. Bump all three together. */
|
|
1741
|
-
declare const VERSION = "0.8.
|
|
1743
|
+
declare const VERSION = "0.8.4";
|
|
1742
1744
|
|
|
1743
1745
|
/**
|
|
1744
1746
|
* This file was auto-generated by openapi-typescript.
|
|
@@ -1755,7 +1757,7 @@ interface paths {
|
|
|
1755
1757
|
};
|
|
1756
1758
|
/**
|
|
1757
1759
|
* Plans, quotas and how to connect (no key required)
|
|
1758
|
-
* @description The only endpoint that answers without a credential. Returns every plan with its monthly request quota, per-minute limit, key limit and a `checkout_url`; the terms
|
|
1760
|
+
* @description The only endpoint that answers without a credential. Returns every plan, Free first, with its monthly request quota, per-minute limit, key limit and a `checkout_url`; the free-plan terms (1,000 requests a month, no card, never expires) and the URL that mints its key; the MCP endpoint with both of its auth doors; and the documentation links. Static per deploy and cached an hour — poll it never, read it once.
|
|
1759
1761
|
*/
|
|
1760
1762
|
get: {
|
|
1761
1763
|
parameters: {
|
|
@@ -1766,7 +1768,7 @@ interface paths {
|
|
|
1766
1768
|
};
|
|
1767
1769
|
requestBody?: never;
|
|
1768
1770
|
responses: {
|
|
1769
|
-
/** @description Plans,
|
|
1771
|
+
/** @description Plans, the free-plan rule, MCP endpoint and links */
|
|
1770
1772
|
200: {
|
|
1771
1773
|
headers: {
|
|
1772
1774
|
[name: string]: unknown;
|
|
@@ -1778,6 +1780,20 @@ interface paths {
|
|
|
1778
1780
|
* "currency": "USD",
|
|
1779
1781
|
* "plans": [
|
|
1780
1782
|
* {
|
|
1783
|
+
* "key": "free",
|
|
1784
|
+
* "name": "Free",
|
|
1785
|
+
* "price_monthly_usd": 0,
|
|
1786
|
+
* "price_yearly_usd": 0,
|
|
1787
|
+
* "requests_per_month": 1000,
|
|
1788
|
+
* "rpm": 10,
|
|
1789
|
+
* "key_limit": 1,
|
|
1790
|
+
* "features": [
|
|
1791
|
+
* "no card",
|
|
1792
|
+
* "never expires"
|
|
1793
|
+
* ],
|
|
1794
|
+
* "checkout_url": "https://www.ufcalendar.com/account/api?trial=1"
|
|
1795
|
+
* },
|
|
1796
|
+
* {
|
|
1781
1797
|
* "key": "hobby",
|
|
1782
1798
|
* "name": "Hobby",
|
|
1783
1799
|
* "price_monthly_usd": 19,
|
|
@@ -1789,11 +1805,12 @@ interface paths {
|
|
|
1789
1805
|
* "checkout_url": "https://www.ufcalendar.com/account/api?plan=hobby"
|
|
1790
1806
|
* }
|
|
1791
1807
|
* ],
|
|
1792
|
-
* "
|
|
1793
|
-
* "
|
|
1794
|
-
* "
|
|
1808
|
+
* "free_plan": {
|
|
1809
|
+
* "requests_per_month": 1000,
|
|
1810
|
+
* "rpm": 10,
|
|
1811
|
+
* "key_limit": 1,
|
|
1795
1812
|
* "card_required": false,
|
|
1796
|
-
* "
|
|
1813
|
+
* "expires": false,
|
|
1797
1814
|
* "start_url": "https://www.ufcalendar.com/account/api?trial=1"
|
|
1798
1815
|
* },
|
|
1799
1816
|
* "mcp": {
|
|
@@ -1919,7 +1936,7 @@ interface paths {
|
|
|
1919
1936
|
"application/json": components["schemas"]["Error"];
|
|
1920
1937
|
};
|
|
1921
1938
|
};
|
|
1922
|
-
/** @description No
|
|
1939
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
1923
1940
|
403: {
|
|
1924
1941
|
headers: {
|
|
1925
1942
|
[name: string]: unknown;
|
|
@@ -2024,7 +2041,7 @@ interface paths {
|
|
|
2024
2041
|
"application/json": components["schemas"]["Error"];
|
|
2025
2042
|
};
|
|
2026
2043
|
};
|
|
2027
|
-
/** @description No
|
|
2044
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
2028
2045
|
403: {
|
|
2029
2046
|
headers: {
|
|
2030
2047
|
[name: string]: unknown;
|
|
@@ -2230,7 +2247,7 @@ interface paths {
|
|
|
2230
2247
|
"application/json": components["schemas"]["Error"];
|
|
2231
2248
|
};
|
|
2232
2249
|
};
|
|
2233
|
-
/** @description No
|
|
2250
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
2234
2251
|
403: {
|
|
2235
2252
|
headers: {
|
|
2236
2253
|
[name: string]: unknown;
|
|
@@ -2294,9 +2311,9 @@ interface paths {
|
|
|
2294
2311
|
org?: "ufc" | "pfl" | "oktagon" | "bkfc" | "rizin";
|
|
2295
2312
|
/** @description Filter on lifecycle status; `postponed` is accepted (2026-09-24). `upcoming` = everything not yet over (announced, scheduled or live), soonest first. */
|
|
2296
2313
|
status?: components["schemas"]["EventStatusFilter"];
|
|
2297
|
-
/** @description
|
|
2314
|
+
/** @description First UTC calendar day, inclusive `YYYY-MM-DD`, matched against the event's `starts_at` (first bell, UTC) — not the venue's local date. Must be a real calendar day. */
|
|
2298
2315
|
from?: string;
|
|
2299
|
-
/** @description
|
|
2316
|
+
/** @description Last UTC calendar day, inclusive `YYYY-MM-DD`, matched against `starts_at` (UTC). An evening card in the Americas starts after midnight UTC, so it falls on the next UTC day: a Saturday-night Las Vegas card needs `to=` the Sunday. Must be a real calendar day. */
|
|
2300
2317
|
to?: string;
|
|
2301
2318
|
/** @description Sort by start time. Defaults are contextual — see endpoint description. */
|
|
2302
2319
|
order?: "asc" | "desc";
|
|
@@ -2411,7 +2428,7 @@ interface paths {
|
|
|
2411
2428
|
"application/json": components["schemas"]["Error"];
|
|
2412
2429
|
};
|
|
2413
2430
|
};
|
|
2414
|
-
/** @description No
|
|
2431
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
2415
2432
|
403: {
|
|
2416
2433
|
headers: {
|
|
2417
2434
|
[name: string]: unknown;
|
|
@@ -2468,6 +2485,8 @@ interface paths {
|
|
|
2468
2485
|
* Event with full card
|
|
2469
2486
|
* @description Full fight card (both corners, results when completed), venue and event-scoped broadcast rows. Every event and card entry carries `sport` (e.g. `mma`, `bare-knuckle-boxing`). Renamed events 308-redirect from stale slugs.
|
|
2470
2487
|
*
|
|
2488
|
+
* **Card order is read over non-cancelled bouts only.** `ordering` runs headliner-first (1 = main event), and `ordering`, `card_section` and `is_main` describe the card as it stands — except on a `status: "cancelled"` entry, which keeps the slot and section it had when it was scratched. The promotion re-lays the card around it afterwards, so a cancelled entry can share an `ordering` with a live bout or sit in a section that no longer matches its neighbours. Filter `status != "cancelled"` before deriving running order or sections.
|
|
2489
|
+
*
|
|
2471
2490
|
* `include=eta` adds `eta` (ISO timestamp or `null`) to every card entry: the estimated start of that bout, by the same rule the website's event page uses. These are estimates, not a schedule — each card section anchors on its declared start, and every completed bout re-anchors the rest of its section on its real finish. Cancelled bouts get `null`.
|
|
2472
2491
|
*
|
|
2473
2492
|
* `include=odds` adds `odds` to every card entry: the current UFCalendar consensus line (`a`, `b`, `favourite`, `fair_probability_a`, `sources`, `recorded_at`), or `null` when the bout is unpriced. Information only, not betting advice; the opening/closing lines and movement are on `/v1/events/{idOrSlug}/odds`.
|
|
@@ -2542,7 +2561,7 @@ interface paths {
|
|
|
2542
2561
|
"application/json": components["schemas"]["Error"];
|
|
2543
2562
|
};
|
|
2544
2563
|
};
|
|
2545
|
-
/** @description No
|
|
2564
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
2546
2565
|
403: {
|
|
2547
2566
|
headers: {
|
|
2548
2567
|
[name: string]: unknown;
|
|
@@ -2657,7 +2676,7 @@ interface paths {
|
|
|
2657
2676
|
"application/json": components["schemas"]["Error"];
|
|
2658
2677
|
};
|
|
2659
2678
|
};
|
|
2660
|
-
/** @description No
|
|
2679
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
2661
2680
|
403: {
|
|
2662
2681
|
headers: {
|
|
2663
2682
|
[name: string]: unknown;
|
|
@@ -2836,7 +2855,7 @@ interface paths {
|
|
|
2836
2855
|
"application/json": components["schemas"]["Error"];
|
|
2837
2856
|
};
|
|
2838
2857
|
};
|
|
2839
|
-
/** @description No
|
|
2858
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
2840
2859
|
403: {
|
|
2841
2860
|
headers: {
|
|
2842
2861
|
[name: string]: unknown;
|
|
@@ -3067,7 +3086,7 @@ interface paths {
|
|
|
3067
3086
|
"application/json": components["schemas"]["Error"];
|
|
3068
3087
|
};
|
|
3069
3088
|
};
|
|
3070
|
-
/** @description No
|
|
3089
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
3071
3090
|
403: {
|
|
3072
3091
|
headers: {
|
|
3073
3092
|
[name: string]: unknown;
|
|
@@ -3218,7 +3237,7 @@ interface paths {
|
|
|
3218
3237
|
"application/json": components["schemas"]["Error"];
|
|
3219
3238
|
};
|
|
3220
3239
|
};
|
|
3221
|
-
/** @description No
|
|
3240
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
3222
3241
|
403: {
|
|
3223
3242
|
headers: {
|
|
3224
3243
|
[name: string]: unknown;
|
|
@@ -3425,7 +3444,7 @@ interface paths {
|
|
|
3425
3444
|
"application/json": components["schemas"]["Error"];
|
|
3426
3445
|
};
|
|
3427
3446
|
};
|
|
3428
|
-
/** @description No
|
|
3447
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
3429
3448
|
403: {
|
|
3430
3449
|
headers: {
|
|
3431
3450
|
[name: string]: unknown;
|
|
@@ -3601,7 +3620,7 @@ interface paths {
|
|
|
3601
3620
|
"application/json": components["schemas"]["Error"];
|
|
3602
3621
|
};
|
|
3603
3622
|
};
|
|
3604
|
-
/** @description No
|
|
3623
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
3605
3624
|
403: {
|
|
3606
3625
|
headers: {
|
|
3607
3626
|
[name: string]: unknown;
|
|
@@ -3673,9 +3692,9 @@ interface paths {
|
|
|
3673
3692
|
fighter?: string;
|
|
3674
3693
|
/** @description Fighter slug or id — bouts this fighter won. */
|
|
3675
3694
|
winner?: string;
|
|
3676
|
-
/** @description
|
|
3695
|
+
/** @description First UTC calendar day, inclusive `YYYY-MM-DD`, matched against the event's `starts_at` (first bell, UTC) — not the venue's local date. Must be a real calendar day. */
|
|
3677
3696
|
from?: string;
|
|
3678
|
-
/** @description
|
|
3697
|
+
/** @description Last UTC calendar day, inclusive `YYYY-MM-DD`, matched against `starts_at` (UTC). An evening card in the Americas starts after midnight UTC, so it falls on the next UTC day: a Saturday-night Las Vegas card needs `to=` the Sunday. Must be a real calendar day. */
|
|
3679
3698
|
to?: string;
|
|
3680
3699
|
/** @description `true` = main events only. */
|
|
3681
3700
|
main_events_only?: boolean;
|
|
@@ -3807,7 +3826,7 @@ interface paths {
|
|
|
3807
3826
|
"application/json": components["schemas"]["Error"];
|
|
3808
3827
|
};
|
|
3809
3828
|
};
|
|
3810
|
-
/** @description No
|
|
3829
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
3811
3830
|
403: {
|
|
3812
3831
|
headers: {
|
|
3813
3832
|
[name: string]: unknown;
|
|
@@ -3992,7 +4011,7 @@ interface paths {
|
|
|
3992
4011
|
"application/json": components["schemas"]["Error"];
|
|
3993
4012
|
};
|
|
3994
4013
|
};
|
|
3995
|
-
/** @description No
|
|
4014
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
3996
4015
|
403: {
|
|
3997
4016
|
headers: {
|
|
3998
4017
|
[name: string]: unknown;
|
|
@@ -4097,7 +4116,7 @@ interface paths {
|
|
|
4097
4116
|
"application/json": components["schemas"]["Error"];
|
|
4098
4117
|
};
|
|
4099
4118
|
};
|
|
4100
|
-
/** @description No
|
|
4119
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
4101
4120
|
403: {
|
|
4102
4121
|
headers: {
|
|
4103
4122
|
[name: string]: unknown;
|
|
@@ -4202,7 +4221,7 @@ interface paths {
|
|
|
4202
4221
|
"application/json": components["schemas"]["Error"];
|
|
4203
4222
|
};
|
|
4204
4223
|
};
|
|
4205
|
-
/** @description No
|
|
4224
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
4206
4225
|
403: {
|
|
4207
4226
|
headers: {
|
|
4208
4227
|
[name: string]: unknown;
|
|
@@ -4257,11 +4276,11 @@ interface paths {
|
|
|
4257
4276
|
};
|
|
4258
4277
|
/**
|
|
4259
4278
|
* Judges' scorecards for a bout
|
|
4260
|
-
* @description The official athletic-commission record: every judge, their score for each round, their card total, the decision type and any point deductions. UFC back to 1995, PFL to 2018, OKTAGON to 2025, RIZIN from March 2026 (Japan has no athletic commission — the record is the one published by the officials body that judges RIZIN). UFC cards are cross-checked against the official scorecards ufc.com publishes (Dana White's Contender Series and Road to UFC included, from March 2022), which also fill bouts the commission record does not cover. `source` says who published the cards: `commission-record`, `ufc-official-cards`, or a promotion's own slug (`oktagon-official`, `pfl-official`, `aca-official`).
|
|
4279
|
+
* @description The official athletic-commission record: every judge, their score for each round, their card total, the decision type and any point deductions. UFC back to 1995, PFL to 2018, OKTAGON to 2025, RIZIN 2019–2022 and from March 2026 (Japan has no athletic commission — the record is the one published by the officials body that judges RIZIN; before March 2026 RIZIN judged each fight as a whole, so those cards carry each judge's total for the fight and no rounds, and 2023–2025 was not published). UFC cards are cross-checked against the official scorecards ufc.com publishes (Dana White's Contender Series and Road to UFC included, from March 2022), which also fill bouts the commission record does not cover. `source` says who published the cards: `commission-record`, `ufc-official-cards`, or a promotion's own slug (`oktagon-official`, `pfl-official`, `aca-official`).
|
|
4261
4280
|
*
|
|
4262
4281
|
* `total_a`/`total_b` and every round are oriented to the bout's `fighter_a_id`/`fighter_b_id`, which are repeated on the payload so you never have to fetch the fight to read a card. `winner_fighter_id` is who THAT judge gave it to.
|
|
4263
4282
|
*
|
|
4264
|
-
* **Check `scores_known` before charting totals.** When it is false the commission published only the outcome, and `total_a`/`total_b` are a 1-0 / 1-1 / 0-0 placeholder rather than a score (
|
|
4283
|
+
* **Check `scores_known` before charting totals.** When it is false the commission published only the outcome, and `total_a`/`total_b` are a 1-0 / 1-1 / 0-0 placeholder rather than a score (pre-2005 commission records, and the RIZIN cards where the officials published only each judge's pick); `rounds` is empty on those cards.
|
|
4265
4284
|
*
|
|
4266
4285
|
* **A bout with no commission record answers 200, not 404** (2026-09-24): `cards: []`, `decision_type: null`, and `meta.note` says why (a finish, or cards not yet published). 404 is reserved for an unknown fight, so a client can tell the two apart.
|
|
4267
4286
|
*
|
|
@@ -4412,7 +4431,7 @@ interface paths {
|
|
|
4412
4431
|
"application/json": components["schemas"]["Error"];
|
|
4413
4432
|
};
|
|
4414
4433
|
};
|
|
4415
|
-
/** @description No
|
|
4434
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
4416
4435
|
403: {
|
|
4417
4436
|
headers: {
|
|
4418
4437
|
[name: string]: unknown;
|
|
@@ -4733,7 +4752,7 @@ interface paths {
|
|
|
4733
4752
|
"application/json": components["schemas"]["Error"];
|
|
4734
4753
|
};
|
|
4735
4754
|
};
|
|
4736
|
-
/** @description No
|
|
4755
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
4737
4756
|
403: {
|
|
4738
4757
|
headers: {
|
|
4739
4758
|
[name: string]: unknown;
|
|
@@ -4793,9 +4812,9 @@ interface paths {
|
|
|
4793
4812
|
get: {
|
|
4794
4813
|
parameters: {
|
|
4795
4814
|
query?: {
|
|
4796
|
-
/** @description Earliest recorded day, inclusive `YYYY-MM-DD`. */
|
|
4815
|
+
/** @description Earliest recorded day (UTC), inclusive `YYYY-MM-DD`. */
|
|
4797
4816
|
from?: string;
|
|
4798
|
-
/** @description Latest recorded day, inclusive `YYYY-MM-DD`; must not precede `from`. */
|
|
4817
|
+
/** @description Latest recorded day (UTC), inclusive `YYYY-MM-DD`; must not precede `from`. */
|
|
4799
4818
|
to?: string;
|
|
4800
4819
|
/** @description Opaque cursor from `meta.pagination.next_cursor`. */
|
|
4801
4820
|
cursor?: string;
|
|
@@ -4965,9 +4984,9 @@ interface paths {
|
|
|
4965
4984
|
query?: {
|
|
4966
4985
|
/** @description Launch org slug: `ufc`, `pfl`, `oktagon`, `bkfc` or `rizin`. Staged orgs 400 until promoted. */
|
|
4967
4986
|
org?: "ufc" | "pfl" | "oktagon" | "bkfc" | "rizin";
|
|
4968
|
-
/** @description
|
|
4987
|
+
/** @description First UTC calendar day, inclusive `YYYY-MM-DD`, matched against the event's `starts_at` (first bell, UTC) — not the venue's local date. Must be a real calendar day. */
|
|
4969
4988
|
from?: string;
|
|
4970
|
-
/** @description
|
|
4989
|
+
/** @description Last UTC calendar day, inclusive `YYYY-MM-DD`, matched against `starts_at` (UTC). An evening card in the Americas starts after midnight UTC, so it falls on the next UTC day: a Saturday-night Las Vegas card needs `to=` the Sunday. Must be a real calendar day. */
|
|
4971
4990
|
to?: string;
|
|
4972
4991
|
/** @description Opaque cursor from `meta.pagination.next_cursor`. */
|
|
4973
4992
|
cursor?: string;
|
|
@@ -5178,7 +5197,7 @@ interface paths {
|
|
|
5178
5197
|
"application/json": components["schemas"]["Error"];
|
|
5179
5198
|
};
|
|
5180
5199
|
};
|
|
5181
|
-
/** @description No
|
|
5200
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
5182
5201
|
403: {
|
|
5183
5202
|
headers: {
|
|
5184
5203
|
[name: string]: unknown;
|
|
@@ -5342,7 +5361,7 @@ interface paths {
|
|
|
5342
5361
|
"application/json": components["schemas"]["Error"];
|
|
5343
5362
|
};
|
|
5344
5363
|
};
|
|
5345
|
-
/** @description No
|
|
5364
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
5346
5365
|
403: {
|
|
5347
5366
|
headers: {
|
|
5348
5367
|
[name: string]: unknown;
|
|
@@ -5447,7 +5466,7 @@ interface paths {
|
|
|
5447
5466
|
"application/json": components["schemas"]["Error"];
|
|
5448
5467
|
};
|
|
5449
5468
|
};
|
|
5450
|
-
/** @description No
|
|
5469
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
5451
5470
|
403: {
|
|
5452
5471
|
headers: {
|
|
5453
5472
|
[name: string]: unknown;
|
|
@@ -5643,7 +5662,7 @@ interface paths {
|
|
|
5643
5662
|
"application/json": components["schemas"]["Error"];
|
|
5644
5663
|
};
|
|
5645
5664
|
};
|
|
5646
|
-
/** @description No
|
|
5665
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
5647
5666
|
403: {
|
|
5648
5667
|
headers: {
|
|
5649
5668
|
[name: string]: unknown;
|
|
@@ -5786,7 +5805,7 @@ interface paths {
|
|
|
5786
5805
|
"application/json": components["schemas"]["Error"];
|
|
5787
5806
|
};
|
|
5788
5807
|
};
|
|
5789
|
-
/** @description No
|
|
5808
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
5790
5809
|
403: {
|
|
5791
5810
|
headers: {
|
|
5792
5811
|
[name: string]: unknown;
|
|
@@ -5841,7 +5860,7 @@ interface paths {
|
|
|
5841
5860
|
};
|
|
5842
5861
|
/**
|
|
5843
5862
|
* Fighter profile
|
|
5844
|
-
* @description Bio, records, stats, UFCalendar Power Index summary, and CC-licensed images with attribution metadata (displaying the credit is a license requirement). **Read `records` and `stats`** (added 2026-09-24): `records` is a map keyed by a clean name — `pro_mma` (the career MMA record), `amateur_mma`, `pro_kickboxing`, …, and the org slug for a record INSIDE one promotion (`ufc`, `one`, `bkfc`) — each `{ value, source, scope }`; `stats` is ONE per-minute panel (SLpM, striking accuracy/defense, SApM, takedown average/accuracy/defense, submission average), always the
|
|
5863
|
+
* @description Bio, records, stats, UFCalendar Power Index summary, and CC-licensed images with attribution metadata (displaying the credit is a license requirement). **Read `records` and `stats`** (added 2026-09-24): `records` is a map keyed by a clean name — `pro_mma` (the career MMA record), `amateur_mma`, `pro_kickboxing`, …, and the org slug for a record INSIDE one promotion (`ufc`, `one`, `bkfc`) — each `{ value, source, scope }`; `stats` is ONE per-minute panel (SLpM, striking accuracy/defense, SApM, takedown average/accuracy/defense, submission average), always ONE sport (the fighter's headline sport: the `pro-mma` panel over MMA bouts in every promotion; `pro-knuckle` for a bare-knuckle fighter, `pro-muay-thai` / `pro-kickboxing` for a ONE striker; sports are never averaged together), with `basis: { bouts, orgs, source, scope }` stating exactly which bouts it averages over (e.g. 7 UFC bouts, or 18 MMA bouts across UFC + Oktagon); `null` when no real panel exists. `career_stats` is the raw per-source row list these are built from and stays unchanged for existing integrations.
|
|
5845
5864
|
*
|
|
5846
5865
|
* `next_fight` is the fighter's next booked bout (not completed or cancelled, on an event that has not been cancelled and started no more than ~6h ago; `result` is always null) and `last_fight` their most recent completed or no-contest bout — both in the same shape as a `source: "native"` row of `/history`, or `null`.
|
|
5847
5866
|
*
|
|
@@ -6111,7 +6130,7 @@ interface paths {
|
|
|
6111
6130
|
"application/json": components["schemas"]["Error"];
|
|
6112
6131
|
};
|
|
6113
6132
|
};
|
|
6114
|
-
/** @description No
|
|
6133
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
6115
6134
|
403: {
|
|
6116
6135
|
headers: {
|
|
6117
6136
|
[name: string]: unknown;
|
|
@@ -6265,7 +6284,7 @@ interface paths {
|
|
|
6265
6284
|
"application/json": components["schemas"]["Error"];
|
|
6266
6285
|
};
|
|
6267
6286
|
};
|
|
6268
|
-
/** @description No
|
|
6287
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
6269
6288
|
403: {
|
|
6270
6289
|
headers: {
|
|
6271
6290
|
[name: string]: unknown;
|
|
@@ -6320,7 +6339,7 @@ interface paths {
|
|
|
6320
6339
|
};
|
|
6321
6340
|
/**
|
|
6322
6341
|
* Career statistics
|
|
6323
|
-
* @description Raw per-source career rows, plus the readable split in `meta.records` / `meta.stats` (the same objects the fighter profile carries — read those unless you need the per-source rows). `data`: per-scope career stats (`pro-mma`, `amateur-mma`, …): record, strikes landed/absorbed per minute, accuracy/defense, takedown and submission averages, and `updated_at` (this route only). Exactly ONE row per scope; `source` names the publisher it came from: `public-records` (the complete multi-promotion career record) is preferred, then the promotion's own site (`ufc-stats`, `bkfc-official`, `one-official`, …), then `ufcalendar`. A `public-records` record is a point-in-time snapshot advanced by every settled bout UFCalendar tracked after it, so it matches the record on ufcalendar.com. A row's record and its stats cover the same bouts. `pro-mma` = the career record plus striking/grappling averages UFCalendar computes over EVERY settled bout it holds per-fight totals for, in any promotion (Contender Series included); its stats are null when no such bout exists. Org-scoped rows (`ufc-only`, `bkfc-only`, `one-only`) are the fighter's record INSIDE that promotion, not a career record: `ufc-only` carries a record AND averages UFCalendar derives from the fighter's tracked UFC bouts only (Contender Series excluded, `W-L-D` plus ` (n NC)`; both null until a UFC bout is settled — a Contender-Series-only fighter has no UFC stats), while `bkfc-only` / `one-only` carry the promotion's own published record.
|
|
6342
|
+
* @description Raw per-source career rows, plus the readable split in `meta.records` / `meta.stats` (the same objects the fighter profile carries — read those unless you need the per-source rows). `data`: per-scope career stats (`pro-mma`, `amateur-mma`, …): record, strikes landed/absorbed per minute, accuracy/defense, takedown and submission averages, and `updated_at` (this route only). Exactly ONE row per scope; `source` names the publisher it came from: `public-records` (the complete multi-promotion career record) is preferred, then the promotion's own site (`ufc-stats`, `bkfc-official`, `one-official`, …), then `ufcalendar`. A `public-records` record is a point-in-time snapshot advanced by every settled bout UFCalendar tracked after it, so it matches the record on ufcalendar.com. A row's record and its stats cover the same bouts. `pro-mma` = the career record plus striking/grappling averages UFCalendar computes over EVERY settled MMA bout it holds per-fight totals for, in any promotion (Contender Series included); its stats are null when no such bout exists. Bouts of another sport are averaged on that sport's row (`pro-knuckle` for bare-knuckle boxing, `pro-muay-thai`, `pro-kickboxing`, `pro-boxing`; a stats-only row with a null record when the fighter has no such record row) and never enter `pro-mma`. Org-scoped rows (`ufc-only`, `bkfc-only`, `one-only`) are the fighter's record INSIDE that promotion, not a career record: `ufc-only` carries a record AND averages UFCalendar derives from the fighter's tracked UFC bouts only (Contender Series excluded, `W-L-D` plus ` (n NC)`; both null until a UFC bout is settled — a Contender-Series-only fighter has no UFC stats), while `bkfc-only` / `one-only` carry the promotion's own published record. ufcstats', OKTAGON's and ACA's header records are CAREER records and ship under `pro-mma` (the `public-records` row wins the scope when present, unless ufcstats counts more bouts).
|
|
6324
6343
|
*/
|
|
6325
6344
|
get: {
|
|
6326
6345
|
parameters: {
|
|
@@ -6380,7 +6399,7 @@ interface paths {
|
|
|
6380
6399
|
"application/json": components["schemas"]["Error"];
|
|
6381
6400
|
};
|
|
6382
6401
|
};
|
|
6383
|
-
/** @description No
|
|
6402
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
6384
6403
|
403: {
|
|
6385
6404
|
headers: {
|
|
6386
6405
|
[name: string]: unknown;
|
|
@@ -6530,7 +6549,7 @@ interface paths {
|
|
|
6530
6549
|
"application/json": components["schemas"]["Error"];
|
|
6531
6550
|
};
|
|
6532
6551
|
};
|
|
6533
|
-
/** @description No
|
|
6552
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
6534
6553
|
403: {
|
|
6535
6554
|
headers: {
|
|
6536
6555
|
[name: string]: unknown;
|
|
@@ -6664,7 +6683,7 @@ interface paths {
|
|
|
6664
6683
|
"application/json": components["schemas"]["Error"];
|
|
6665
6684
|
};
|
|
6666
6685
|
};
|
|
6667
|
-
/** @description No
|
|
6686
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
6668
6687
|
403: {
|
|
6669
6688
|
headers: {
|
|
6670
6689
|
[name: string]: unknown;
|
|
@@ -6910,7 +6929,7 @@ interface paths {
|
|
|
6910
6929
|
"application/json": components["schemas"]["Error"];
|
|
6911
6930
|
};
|
|
6912
6931
|
};
|
|
6913
|
-
/** @description No
|
|
6932
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
6914
6933
|
403: {
|
|
6915
6934
|
headers: {
|
|
6916
6935
|
[name: string]: unknown;
|
|
@@ -7099,7 +7118,7 @@ interface paths {
|
|
|
7099
7118
|
"application/json": components["schemas"]["Error"];
|
|
7100
7119
|
};
|
|
7101
7120
|
};
|
|
7102
|
-
/** @description No
|
|
7121
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
7103
7122
|
403: {
|
|
7104
7123
|
headers: {
|
|
7105
7124
|
[name: string]: unknown;
|
|
@@ -7251,7 +7270,7 @@ interface paths {
|
|
|
7251
7270
|
"application/json": components["schemas"]["Error"];
|
|
7252
7271
|
};
|
|
7253
7272
|
};
|
|
7254
|
-
/** @description No
|
|
7273
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
7255
7274
|
403: {
|
|
7256
7275
|
headers: {
|
|
7257
7276
|
[name: string]: unknown;
|
|
@@ -7392,7 +7411,7 @@ interface paths {
|
|
|
7392
7411
|
"application/json": components["schemas"]["Error"];
|
|
7393
7412
|
};
|
|
7394
7413
|
};
|
|
7395
|
-
/** @description No
|
|
7414
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
7396
7415
|
403: {
|
|
7397
7416
|
headers: {
|
|
7398
7417
|
[name: string]: unknown;
|
|
@@ -7547,7 +7566,7 @@ interface paths {
|
|
|
7547
7566
|
"application/json": components["schemas"]["Error"];
|
|
7548
7567
|
};
|
|
7549
7568
|
};
|
|
7550
|
-
/** @description No
|
|
7569
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
7551
7570
|
403: {
|
|
7552
7571
|
headers: {
|
|
7553
7572
|
[name: string]: unknown;
|
|
@@ -7602,7 +7621,7 @@ interface paths {
|
|
|
7602
7621
|
};
|
|
7603
7622
|
/**
|
|
7604
7623
|
* Matchmaker board
|
|
7605
|
-
* @description UFCalendar's matchmaker for one MMA promotion (`ufc`, `pfl`, `oktagon`, `rizin`; `bkfc` 400s `unsupported_org` — the engine runs on the Power Index, which rates MMA only). Every candidate pair inside a division is scored 0–100 for rank proximity, momentum, competitiveness, readiness and story (rematches, trilogy deciders, eliminators): the promotion's official ladder where one exists plus the strongest active unranked Power Index fighters. UFC pairs are scored by UFCalendar's booking model (a ranker trained on every realized UFC booking), weighted by the stakes term; other promotions use the fitted heuristic. Fighters already booked leave the board, pairs already booked are excluded, and one fighter appears in at most two slips per division.
|
|
7624
|
+
* @description UFCalendar's matchmaker for one MMA promotion (`ufc`, `pfl`, `oktagon`, `rizin`; `bkfc` 400s `unsupported_org` — the engine runs on the Power Index, which rates MMA only). Every candidate pair inside a division is scored 0–100 for rank proximity, momentum, competitiveness, readiness and story (rematches, trilogy deciders, eliminators): the promotion's official ladder where one exists plus the strongest active unranked Power Index fighters. A promotion with no official ladder (`rizin`) draws only on its current roster — fighters whose latest bout in the promotion is within 450 days — and its pairs are weighted by what each fighter has done there (title fights, wins, career pedigree), so a former champion is not paired with a two-fight prospect. UFC and RIZIN pairs are scored by UFCalendar's booking model (a ranker trained on every realized UFC booking, which also beat the heuristic on RIZIN's own bookings), weighted by the stakes term; other promotions use the fitted heuristic. Fighters already booked leave the board, pairs already booked are excluded, and one fighter appears in at most two slips per division.
|
|
7606
7625
|
*
|
|
7607
7626
|
* Without `division` the list is the cross-division top board (at most two slips per division); with it, that division's best pairs. `meta.divisions` lists the promotion's divisions (an unknown one 400s `invalid_division`), `meta.rankings_date` the ladder snapshot used (null when the promotion has no current ladder). Each slip: `key` (`lo-hi` fighter ids), `a` (red corner — the better-credentialed side) and `b` with `rank` (0 = champion, null = unranked), `power_index`, `streak` (signed: +3 = three straight wins) and `booked`; `score`; `win_probability_a` from the two Power Index ratings; `tags` (`title`, `eliminator`, `coinFlip`, `bothStreaking`, `finishers`, `trilogyDecider`, `unfinishedBusiness`, `rematch`, `unrankedGem`, `bounceBack`, `steppingUp`, `bothDue`, `booked`).
|
|
7608
7627
|
*
|
|
@@ -7726,7 +7745,7 @@ interface paths {
|
|
|
7726
7745
|
"application/json": components["schemas"]["Error"];
|
|
7727
7746
|
};
|
|
7728
7747
|
};
|
|
7729
|
-
/** @description No
|
|
7748
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
7730
7749
|
403: {
|
|
7731
7750
|
headers: {
|
|
7732
7751
|
[name: string]: unknown;
|
|
@@ -7899,7 +7918,7 @@ interface paths {
|
|
|
7899
7918
|
"application/json": components["schemas"]["Error"];
|
|
7900
7919
|
};
|
|
7901
7920
|
};
|
|
7902
|
-
/** @description No
|
|
7921
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
7903
7922
|
403: {
|
|
7904
7923
|
headers: {
|
|
7905
7924
|
[name: string]: unknown;
|
|
@@ -8081,7 +8100,7 @@ interface paths {
|
|
|
8081
8100
|
"application/json": components["schemas"]["Error"];
|
|
8082
8101
|
};
|
|
8083
8102
|
};
|
|
8084
|
-
/** @description No
|
|
8103
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
8085
8104
|
403: {
|
|
8086
8105
|
headers: {
|
|
8087
8106
|
[name: string]: unknown;
|
|
@@ -8273,7 +8292,7 @@ interface paths {
|
|
|
8273
8292
|
"application/json": components["schemas"]["Error"];
|
|
8274
8293
|
};
|
|
8275
8294
|
};
|
|
8276
|
-
/** @description No
|
|
8295
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
8277
8296
|
403: {
|
|
8278
8297
|
headers: {
|
|
8279
8298
|
[name: string]: unknown;
|
|
@@ -8509,7 +8528,7 @@ interface paths {
|
|
|
8509
8528
|
"application/json": components["schemas"]["Error"];
|
|
8510
8529
|
};
|
|
8511
8530
|
};
|
|
8512
|
-
/** @description No
|
|
8531
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
8513
8532
|
403: {
|
|
8514
8533
|
headers: {
|
|
8515
8534
|
[name: string]: unknown;
|
|
@@ -8615,7 +8634,7 @@ interface paths {
|
|
|
8615
8634
|
"application/json": components["schemas"]["Error"];
|
|
8616
8635
|
};
|
|
8617
8636
|
};
|
|
8618
|
-
/** @description No
|
|
8637
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
8619
8638
|
403: {
|
|
8620
8639
|
headers: {
|
|
8621
8640
|
[name: string]: unknown;
|
|
@@ -8752,7 +8771,7 @@ interface paths {
|
|
|
8752
8771
|
"application/json": components["schemas"]["Error"];
|
|
8753
8772
|
};
|
|
8754
8773
|
};
|
|
8755
|
-
/** @description No
|
|
8774
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
8756
8775
|
403: {
|
|
8757
8776
|
headers: {
|
|
8758
8777
|
[name: string]: unknown;
|
|
@@ -8894,7 +8913,7 @@ interface paths {
|
|
|
8894
8913
|
"application/json": components["schemas"]["Error"];
|
|
8895
8914
|
};
|
|
8896
8915
|
};
|
|
8897
|
-
/** @description No
|
|
8916
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
8898
8917
|
403: {
|
|
8899
8918
|
headers: {
|
|
8900
8919
|
[name: string]: unknown;
|
|
@@ -8956,7 +8975,9 @@ interface paths {
|
|
|
8956
8975
|
query?: {
|
|
8957
8976
|
/** @description Same values as `/v1/events`; `upcoming` = the venue's cards not yet over. */
|
|
8958
8977
|
status?: components["schemas"]["EventStatusFilter"];
|
|
8978
|
+
/** @description First UTC calendar day, inclusive `YYYY-MM-DD`, matched against the event's `starts_at` (first bell, UTC) — not the venue's local date. Must be a real calendar day. */
|
|
8959
8979
|
from?: string;
|
|
8980
|
+
/** @description Last UTC calendar day, inclusive `YYYY-MM-DD`, matched against `starts_at` (UTC). An evening card in the Americas starts after midnight UTC, so it falls on the next UTC day: a Saturday-night Las Vegas card needs `to=` the Sunday. Must be a real calendar day. */
|
|
8960
8981
|
to?: string;
|
|
8961
8982
|
order?: "asc" | "desc";
|
|
8962
8983
|
/** @description Opaque cursor from `meta.pagination.next_cursor`. */
|
|
@@ -9057,7 +9078,7 @@ interface paths {
|
|
|
9057
9078
|
"application/json": components["schemas"]["Error"];
|
|
9058
9079
|
};
|
|
9059
9080
|
};
|
|
9060
|
-
/** @description No
|
|
9081
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
9061
9082
|
403: {
|
|
9062
9083
|
headers: {
|
|
9063
9084
|
[name: string]: unknown;
|
|
@@ -9180,7 +9201,7 @@ interface paths {
|
|
|
9180
9201
|
"application/json": components["schemas"]["Error"];
|
|
9181
9202
|
};
|
|
9182
9203
|
};
|
|
9183
|
-
/** @description No
|
|
9204
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
9184
9205
|
403: {
|
|
9185
9206
|
headers: {
|
|
9186
9207
|
[name: string]: unknown;
|
|
@@ -9329,7 +9350,7 @@ interface paths {
|
|
|
9329
9350
|
"application/json": components["schemas"]["Error"];
|
|
9330
9351
|
};
|
|
9331
9352
|
};
|
|
9332
|
-
/** @description No
|
|
9353
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
9333
9354
|
403: {
|
|
9334
9355
|
headers: {
|
|
9335
9356
|
[name: string]: unknown;
|
|
@@ -9470,7 +9491,7 @@ interface paths {
|
|
|
9470
9491
|
"application/json": components["schemas"]["Error"];
|
|
9471
9492
|
};
|
|
9472
9493
|
};
|
|
9473
|
-
/** @description No
|
|
9494
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
9474
9495
|
403: {
|
|
9475
9496
|
headers: {
|
|
9476
9497
|
[name: string]: unknown;
|
|
@@ -9610,7 +9631,7 @@ interface paths {
|
|
|
9610
9631
|
"application/json": components["schemas"]["Error"];
|
|
9611
9632
|
};
|
|
9612
9633
|
};
|
|
9613
|
-
/** @description No
|
|
9634
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
9614
9635
|
403: {
|
|
9615
9636
|
headers: {
|
|
9616
9637
|
[name: string]: unknown;
|
|
@@ -9699,7 +9720,7 @@ interface paths {
|
|
|
9699
9720
|
"application/json": components["schemas"]["Error"];
|
|
9700
9721
|
};
|
|
9701
9722
|
};
|
|
9702
|
-
/** @description No
|
|
9723
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
9703
9724
|
403: {
|
|
9704
9725
|
headers: {
|
|
9705
9726
|
[name: string]: unknown;
|
|
@@ -10194,7 +10215,7 @@ interface paths {
|
|
|
10194
10215
|
};
|
|
10195
10216
|
/**
|
|
10196
10217
|
* Your quota usage
|
|
10197
|
-
* @description Current-month usage for the calling key: tier, requests used/limit, rpm limit, and the reset as both a Unix timestamp (`reset`) and ISO-8601 (`reset_at`); `month` (`YYYYMM`) and `period` (`YYYY-MM`) are the same month in two spellings. On the free 1-
|
|
10218
|
+
* @description Current-month usage for the calling key: tier, requests used/limit, rpm limit, and the reset as both a Unix timestamp (`reset`) and ISO-8601 (`reset_at`); `month` (`YYYYMM`) and `period` (`YYYY-MM`) are the same month in two spellings. On the free plan `tier` is `free` (1,000 requests a month, metered per account). On an owner-granted trial, `trial_ends_at` is when the trial ends (null otherwise) — plan around it, not `reset_at`.
|
|
10198
10219
|
*/
|
|
10199
10220
|
get: {
|
|
10200
10221
|
parameters: {
|
|
@@ -10258,7 +10279,7 @@ interface paths {
|
|
|
10258
10279
|
"application/json": components["schemas"]["Error"];
|
|
10259
10280
|
};
|
|
10260
10281
|
};
|
|
10261
|
-
/** @description No
|
|
10282
|
+
/** @description No plan on the credential (`subscription_required`) — rare: every account with a key is on at least the free plan (1,000 requests/month, no card; keys at https://www.ufcalendar.com/account/api). */
|
|
10262
10283
|
403: {
|
|
10263
10284
|
headers: {
|
|
10264
10285
|
[name: string]: unknown;
|
|
@@ -10356,7 +10377,7 @@ interface components {
|
|
|
10356
10377
|
* @description Plan tier.
|
|
10357
10378
|
* @enum {string}
|
|
10358
10379
|
*/
|
|
10359
|
-
Tier: "trial" | "hobby" | "pro" | "business";
|
|
10380
|
+
Tier: "free" | "trial" | "hobby" | "pro" | "business";
|
|
10360
10381
|
/**
|
|
10361
10382
|
* @description Webhook event types.
|
|
10362
10383
|
* @enum {string}
|
|
@@ -10987,7 +11008,10 @@ interface components {
|
|
|
10987
11008
|
event_title: string;
|
|
10988
11009
|
event_slug: string;
|
|
10989
11010
|
org_slug: string;
|
|
10990
|
-
/**
|
|
11011
|
+
/**
|
|
11012
|
+
* Format: date
|
|
11013
|
+
* @description The UTC calendar day of the event's `starts_at` (first bell). An evening card in the Americas starts after midnight UTC, so it can read one day after the venue's local date; use the event's `starts_at` + `tz` for a local label.
|
|
11014
|
+
*/
|
|
10991
11015
|
date: string | null;
|
|
10992
11016
|
opponent_id: number | null;
|
|
10993
11017
|
opponent_name: string | null;
|
|
@@ -11300,7 +11324,10 @@ interface components {
|
|
|
11300
11324
|
event_name: string | null;
|
|
11301
11325
|
event_slug: string | null;
|
|
11302
11326
|
org_slug: string | null;
|
|
11303
|
-
/**
|
|
11327
|
+
/**
|
|
11328
|
+
* Format: date
|
|
11329
|
+
* @description `native` rows: the UTC calendar day of the event's `starts_at` (first bell) — an evening card in the Americas starts after midnight UTC, so it can read one day after the venue's local date. `history` rows carry no time, only the date as the publisher printed it (usually the venue's local date).
|
|
11330
|
+
*/
|
|
11304
11331
|
date: string | null;
|
|
11305
11332
|
opponent_id: number | null;
|
|
11306
11333
|
opponent_name: string | null;
|
|
@@ -12334,7 +12361,7 @@ interface components {
|
|
|
12334
12361
|
reset_at: string;
|
|
12335
12362
|
/**
|
|
12336
12363
|
* Format: date-time
|
|
12337
|
-
* @description
|
|
12364
|
+
* @description Owner-granted trials only: when the trial ends and the account falls back to the free plan — usually well before `reset_at`. Null on the free plan and on a paid plan.
|
|
12338
12365
|
*/
|
|
12339
12366
|
trial_ends_at: string | null;
|
|
12340
12367
|
};
|
|
@@ -12352,11 +12379,13 @@ interface components {
|
|
|
12352
12379
|
Plans: {
|
|
12353
12380
|
currency: string;
|
|
12354
12381
|
plans: components["schemas"]["Plan"][];
|
|
12355
|
-
|
|
12356
|
-
|
|
12357
|
-
|
|
12382
|
+
free_plan: {
|
|
12383
|
+
requests_per_month: number;
|
|
12384
|
+
rpm: number;
|
|
12385
|
+
key_limit: number;
|
|
12358
12386
|
card_required: boolean;
|
|
12359
|
-
|
|
12387
|
+
/** @description Always false: the free plan never expires. */
|
|
12388
|
+
expires: boolean;
|
|
12360
12389
|
start_url: string;
|
|
12361
12390
|
};
|
|
12362
12391
|
mcp: {
|