blizzardapi3 3.0.0__tar.gz → 3.0.2__tar.gz
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.
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/PKG-INFO +1 -10
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/README.md +0 -9
- blizzardapi3-3.0.2/blizzardapi3/config/endpoints/d3_community.yaml +168 -0
- blizzardapi3-3.0.2/blizzardapi3/config/endpoints/d3_game_data.yaml +52 -0
- blizzardapi3-3.0.2/blizzardapi3/config/endpoints/hs_game_data.yaml +68 -0
- blizzardapi3-3.0.2/blizzardapi3/config/endpoints/sc2_community.yaml +107 -0
- blizzardapi3-3.0.2/blizzardapi3/config/endpoints/sc2_game_data.yaml +13 -0
- blizzardapi3-3.0.2/blizzardapi3/config/endpoints/wow_game_data.yaml +1072 -0
- blizzardapi3-3.0.2/blizzardapi3/config/endpoints/wow_profile.yaml +347 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3.egg-info/PKG-INFO +1 -10
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3.egg-info/SOURCES.txt +7 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/pyproject.toml +5 -4
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3/__init__.py +0 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3/api/__init__.py +0 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3/api/wow.py +0 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3/blizzard_api.py +0 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3/core/__init__.py +0 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3/core/auth.py +0 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3/core/client.py +0 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3/core/context.py +0 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3/core/executor.py +0 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3/core/factory.py +0 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3/core/registry.py +0 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3/exceptions/__init__.py +0 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3/exceptions/auth.py +0 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3/exceptions/base.py +0 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3/exceptions/request.py +0 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3/exceptions/validation.py +0 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3/types.py +0 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3.egg-info/dependency_links.txt +0 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3.egg-info/requires.txt +0 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/blizzardapi3.egg-info/top_level.txt +0 -0
- {blizzardapi3-3.0.0 → blizzardapi3-3.0.2}/setup.cfg +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: blizzardapi3
|
|
3
|
-
Version: 3.0.
|
|
3
|
+
Version: 3.0.2
|
|
4
4
|
Summary: A modern, config-driven Python wrapper for the Blizzard API with async support
|
|
5
5
|
Author-email: lostcol0ny <c098os0k@4wrd.cc>
|
|
6
6
|
License-Expression: MIT
|
|
@@ -381,7 +381,6 @@ with BlizzardAPI(client_id, client_secret) as api:
|
|
|
381
381
|
- **[Search Guide](docs/SEARCH_GUIDE.md)** - Comprehensive guide to using search endpoints with real-world examples
|
|
382
382
|
- **[Search Quick Reference](docs/SEARCH_QUICK_REFERENCE.md)** - Quick reference for all search methods and parameters
|
|
383
383
|
- **[OAuth Guide](docs/OAUTH_GUIDE.md)** - Complete guide to OAuth authorization code flow for user-specific endpoints
|
|
384
|
-
- **[Migration Guide](MIGRATION.md)** - Detailed guide for migrating from blizzardapi2
|
|
385
384
|
|
|
386
385
|
### Additional Resources
|
|
387
386
|
|
|
@@ -389,10 +388,6 @@ with BlizzardAPI(client_id, client_secret) as api:
|
|
|
389
388
|
- [GitHub Repository](https://github.com/lostcol0ny/blizzardapi3)
|
|
390
389
|
- [Issue Tracker](https://github.com/lostcol0ny/blizzardapi3/issues)
|
|
391
390
|
|
|
392
|
-
## Migration from v2
|
|
393
|
-
|
|
394
|
-
See [MIGRATION.md](MIGRATION.md) for a detailed guide on migrating from blizzardapi2.
|
|
395
|
-
|
|
396
391
|
## Development
|
|
397
392
|
|
|
398
393
|
```bash
|
|
@@ -420,7 +415,3 @@ BlizzardAPI v3 uses a config-driven architecture:
|
|
|
420
415
|
- **Pydantic Models** - Type-safe response models
|
|
421
416
|
- **Custom Exceptions** - Detailed error hierarchy
|
|
422
417
|
- **Single Session** - Efficient session management with proper cleanup
|
|
423
|
-
|
|
424
|
-
## License
|
|
425
|
-
|
|
426
|
-
MIT License - see [LICENSE](LICENSE) for details
|
|
@@ -348,7 +348,6 @@ with BlizzardAPI(client_id, client_secret) as api:
|
|
|
348
348
|
- **[Search Guide](docs/SEARCH_GUIDE.md)** - Comprehensive guide to using search endpoints with real-world examples
|
|
349
349
|
- **[Search Quick Reference](docs/SEARCH_QUICK_REFERENCE.md)** - Quick reference for all search methods and parameters
|
|
350
350
|
- **[OAuth Guide](docs/OAUTH_GUIDE.md)** - Complete guide to OAuth authorization code flow for user-specific endpoints
|
|
351
|
-
- **[Migration Guide](MIGRATION.md)** - Detailed guide for migrating from blizzardapi2
|
|
352
351
|
|
|
353
352
|
### Additional Resources
|
|
354
353
|
|
|
@@ -356,10 +355,6 @@ with BlizzardAPI(client_id, client_secret) as api:
|
|
|
356
355
|
- [GitHub Repository](https://github.com/lostcol0ny/blizzardapi3)
|
|
357
356
|
- [Issue Tracker](https://github.com/lostcol0ny/blizzardapi3/issues)
|
|
358
357
|
|
|
359
|
-
## Migration from v2
|
|
360
|
-
|
|
361
|
-
See [MIGRATION.md](MIGRATION.md) for a detailed guide on migrating from blizzardapi2.
|
|
362
|
-
|
|
363
358
|
## Development
|
|
364
359
|
|
|
365
360
|
```bash
|
|
@@ -387,7 +382,3 @@ BlizzardAPI v3 uses a config-driven architecture:
|
|
|
387
382
|
- **Pydantic Models** - Type-safe response models
|
|
388
383
|
- **Custom Exceptions** - Detailed error hierarchy
|
|
389
384
|
- **Single Session** - Efficient session management with proper cleanup
|
|
390
|
-
|
|
391
|
-
## License
|
|
392
|
-
|
|
393
|
-
MIT License - see [LICENSE](LICENSE) for details
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
version: "3.0"
|
|
2
|
+
game: "d3"
|
|
3
|
+
api_type: "community"
|
|
4
|
+
|
|
5
|
+
# Reusable pattern templates for Diablo 3 Community API
|
|
6
|
+
pattern_templates:
|
|
7
|
+
simple_index:
|
|
8
|
+
path_template: "/d3/data/{resource}"
|
|
9
|
+
params: ["region", "locale"]
|
|
10
|
+
namespace_type: "none"
|
|
11
|
+
supports_classic: false
|
|
12
|
+
|
|
13
|
+
get_by_slug:
|
|
14
|
+
path_template: "/d3/data/{resource}/{slug}"
|
|
15
|
+
params: ["region", "locale", "slug"]
|
|
16
|
+
namespace_type: "none"
|
|
17
|
+
supports_classic: false
|
|
18
|
+
|
|
19
|
+
# Endpoint definitions
|
|
20
|
+
endpoints:
|
|
21
|
+
# Profile API
|
|
22
|
+
- method_name: "get_account"
|
|
23
|
+
path_template: "/d3/profile/{battletag}/"
|
|
24
|
+
params: ["region", "locale", "battletag"]
|
|
25
|
+
namespace_type: "none"
|
|
26
|
+
description: "Get Diablo 3 account profile by BattleTag"
|
|
27
|
+
response_model: "D3Account"
|
|
28
|
+
|
|
29
|
+
- method_name: "get_hero"
|
|
30
|
+
path_template: "/d3/profile/{battletag}/hero/{hero_id}"
|
|
31
|
+
params: ["region", "locale", "battletag", "hero_id"]
|
|
32
|
+
namespace_type: "none"
|
|
33
|
+
description: "Get a single hero by BattleTag and hero ID"
|
|
34
|
+
response_model: "D3Hero"
|
|
35
|
+
|
|
36
|
+
- method_name: "get_hero_items"
|
|
37
|
+
path_template: "/d3/profile/{battletag}/hero/{hero_id}/items"
|
|
38
|
+
params: ["region", "locale", "battletag", "hero_id"]
|
|
39
|
+
namespace_type: "none"
|
|
40
|
+
description: "Get items for a hero"
|
|
41
|
+
response_model: "D3HeroItems"
|
|
42
|
+
|
|
43
|
+
- method_name: "get_hero_follower_items"
|
|
44
|
+
path_template: "/d3/profile/{battletag}/hero/{hero_id}/follower-items"
|
|
45
|
+
params: ["region", "locale", "battletag", "hero_id"]
|
|
46
|
+
namespace_type: "none"
|
|
47
|
+
description: "Get follower items for a hero"
|
|
48
|
+
response_model: "D3FollowerItems"
|
|
49
|
+
|
|
50
|
+
# Act API
|
|
51
|
+
- method_name: "get_act_index"
|
|
52
|
+
path_template: "/d3/data/act"
|
|
53
|
+
params: ["region", "locale"]
|
|
54
|
+
namespace_type: "none"
|
|
55
|
+
description: "Get an index of acts"
|
|
56
|
+
response_model: "D3ActIndex"
|
|
57
|
+
|
|
58
|
+
- method_name: "get_act"
|
|
59
|
+
path_template: "/d3/data/act/{act_id}"
|
|
60
|
+
params: ["region", "locale", "act_id"]
|
|
61
|
+
namespace_type: "none"
|
|
62
|
+
description: "Get an act by ID"
|
|
63
|
+
response_model: "D3Act"
|
|
64
|
+
|
|
65
|
+
# Artisan and Recipe API
|
|
66
|
+
- method_name: "get_artisan"
|
|
67
|
+
path_template: "/d3/data/artisan/{artisan_slug}"
|
|
68
|
+
params: ["region", "locale", "artisan_slug"]
|
|
69
|
+
namespace_type: "none"
|
|
70
|
+
description: "Get an artisan by slug"
|
|
71
|
+
response_model: "D3Artisan"
|
|
72
|
+
|
|
73
|
+
- method_name: "get_recipe"
|
|
74
|
+
path_template: "/d3/data/artisan/{artisan_slug}/recipe/{recipe_slug}"
|
|
75
|
+
params: ["region", "locale", "artisan_slug", "recipe_slug"]
|
|
76
|
+
namespace_type: "none"
|
|
77
|
+
description: "Get a recipe for an artisan"
|
|
78
|
+
response_model: "D3Recipe"
|
|
79
|
+
|
|
80
|
+
# Follower API
|
|
81
|
+
- method_name: "get_follower"
|
|
82
|
+
path_template: "/d3/data/follower/{follower_slug}"
|
|
83
|
+
params: ["region", "locale", "follower_slug"]
|
|
84
|
+
namespace_type: "none"
|
|
85
|
+
description: "Get a follower by slug"
|
|
86
|
+
response_model: "D3Follower"
|
|
87
|
+
|
|
88
|
+
# Character Class and Skill API
|
|
89
|
+
- method_name: "get_character_class"
|
|
90
|
+
path_template: "/d3/data/hero/{class_slug}"
|
|
91
|
+
params: ["region", "locale", "class_slug"]
|
|
92
|
+
namespace_type: "none"
|
|
93
|
+
description: "Get a character class by slug"
|
|
94
|
+
response_model: "D3CharacterClass"
|
|
95
|
+
|
|
96
|
+
- method_name: "get_api_skill"
|
|
97
|
+
path_template: "/d3/data/hero/{class_slug}/skill/{skill_slug}"
|
|
98
|
+
params: ["region", "locale", "class_slug", "skill_slug"]
|
|
99
|
+
namespace_type: "none"
|
|
100
|
+
description: "Get a skill for a character class"
|
|
101
|
+
response_model: "D3Skill"
|
|
102
|
+
|
|
103
|
+
# Item Type API
|
|
104
|
+
- method_name: "get_item_type_index"
|
|
105
|
+
path_template: "/d3/data/item-type"
|
|
106
|
+
params: ["region", "locale"]
|
|
107
|
+
namespace_type: "none"
|
|
108
|
+
description: "Get an index of item types"
|
|
109
|
+
response_model: "D3ItemTypeIndex"
|
|
110
|
+
|
|
111
|
+
- method_name: "get_item_type"
|
|
112
|
+
path_template: "/d3/data/item-type/{item_type_slug}"
|
|
113
|
+
params: ["region", "locale", "item_type_slug"]
|
|
114
|
+
namespace_type: "none"
|
|
115
|
+
description: "Get an item type by slug"
|
|
116
|
+
response_model: "D3ItemType"
|
|
117
|
+
|
|
118
|
+
# Item API
|
|
119
|
+
- method_name: "get_item"
|
|
120
|
+
path_template: "/d3/data/item/{item_slug_and_id}"
|
|
121
|
+
params: ["region", "locale", "item_slug_and_id"]
|
|
122
|
+
namespace_type: "none"
|
|
123
|
+
description: "Get an item by slug and ID"
|
|
124
|
+
response_model: "D3Item"
|
|
125
|
+
|
|
126
|
+
# Season and Leaderboard API
|
|
127
|
+
- method_name: "get_season_index"
|
|
128
|
+
path_template: "/data/d3/season/"
|
|
129
|
+
params: ["region", "locale"]
|
|
130
|
+
namespace_type: "none"
|
|
131
|
+
description: "Get an index of seasons"
|
|
132
|
+
response_model: "D3SeasonIndex"
|
|
133
|
+
|
|
134
|
+
- method_name: "get_season"
|
|
135
|
+
path_template: "/data/d3/season/{season_id}"
|
|
136
|
+
params: ["region", "locale", "season_id"]
|
|
137
|
+
namespace_type: "none"
|
|
138
|
+
description: "Get a season by ID"
|
|
139
|
+
response_model: "D3Season"
|
|
140
|
+
|
|
141
|
+
- method_name: "get_season_leaderboard"
|
|
142
|
+
path_template: "/data/d3/season/{season_id}/leaderboard/{leaderboard}"
|
|
143
|
+
params: ["region", "locale", "season_id", "leaderboard"]
|
|
144
|
+
namespace_type: "none"
|
|
145
|
+
description: "Get a season leaderboard"
|
|
146
|
+
response_model: "D3SeasonLeaderboard"
|
|
147
|
+
|
|
148
|
+
# Era and Leaderboard API
|
|
149
|
+
- method_name: "get_era_index"
|
|
150
|
+
path_template: "/data/d3/era/"
|
|
151
|
+
params: ["region", "locale"]
|
|
152
|
+
namespace_type: "none"
|
|
153
|
+
description: "Get an index of eras"
|
|
154
|
+
response_model: "D3EraIndex"
|
|
155
|
+
|
|
156
|
+
- method_name: "get_era"
|
|
157
|
+
path_template: "/data/d3/era/{era_id}"
|
|
158
|
+
params: ["region", "locale", "era_id"]
|
|
159
|
+
namespace_type: "none"
|
|
160
|
+
description: "Get an era by ID"
|
|
161
|
+
response_model: "D3Era"
|
|
162
|
+
|
|
163
|
+
- method_name: "get_era_leaderboard"
|
|
164
|
+
path_template: "/data/d3/era/{era_id}/leaderboard/{leaderboard}"
|
|
165
|
+
params: ["region", "locale", "era_id", "leaderboard"]
|
|
166
|
+
namespace_type: "none"
|
|
167
|
+
description: "Get an era leaderboard"
|
|
168
|
+
response_model: "D3EraLeaderboard"
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
version: "3.0"
|
|
2
|
+
game: "d3"
|
|
3
|
+
api_type: "game_data"
|
|
4
|
+
|
|
5
|
+
# Endpoint definitions
|
|
6
|
+
endpoints:
|
|
7
|
+
# Item API
|
|
8
|
+
- method_name: "get_item"
|
|
9
|
+
path_template: "/d3/data/item/{item_slug_and_id}"
|
|
10
|
+
params: ["region", "locale", "item_slug_and_id"]
|
|
11
|
+
namespace_type: "none"
|
|
12
|
+
description: "Get an item by slug and ID (game data)"
|
|
13
|
+
response_model: "D3Item"
|
|
14
|
+
|
|
15
|
+
# Item Type API
|
|
16
|
+
- method_name: "get_item_type_index"
|
|
17
|
+
path_template: "/d3/data/item-type"
|
|
18
|
+
params: ["region", "locale"]
|
|
19
|
+
namespace_type: "none"
|
|
20
|
+
description: "Get an index of item types"
|
|
21
|
+
response_model: "D3ItemTypeIndex"
|
|
22
|
+
|
|
23
|
+
- method_name: "get_item_type"
|
|
24
|
+
path_template: "/d3/data/item-type/{item_type_slug}"
|
|
25
|
+
params: ["region", "locale", "item_type_slug"]
|
|
26
|
+
namespace_type: "none"
|
|
27
|
+
description: "Get an item type by slug"
|
|
28
|
+
response_model: "D3ItemType"
|
|
29
|
+
|
|
30
|
+
# Recipe API
|
|
31
|
+
- method_name: "get_recipe"
|
|
32
|
+
path_template: "/d3/data/artisan/{artisan_slug}/recipe/{recipe_slug}"
|
|
33
|
+
params: ["region", "locale", "artisan_slug", "recipe_slug"]
|
|
34
|
+
namespace_type: "none"
|
|
35
|
+
description: "Get a recipe for an artisan"
|
|
36
|
+
response_model: "D3Recipe"
|
|
37
|
+
|
|
38
|
+
# Follower API
|
|
39
|
+
- method_name: "get_follower"
|
|
40
|
+
path_template: "/d3/data/follower/{follower_slug}"
|
|
41
|
+
params: ["region", "locale", "follower_slug"]
|
|
42
|
+
namespace_type: "none"
|
|
43
|
+
description: "Get a follower by slug"
|
|
44
|
+
response_model: "D3Follower"
|
|
45
|
+
|
|
46
|
+
# Artisan API
|
|
47
|
+
- method_name: "get_artisan"
|
|
48
|
+
path_template: "/d3/data/artisan/{artisan_slug}"
|
|
49
|
+
params: ["region", "locale", "artisan_slug"]
|
|
50
|
+
namespace_type: "none"
|
|
51
|
+
description: "Get an artisan by slug"
|
|
52
|
+
response_model: "D3Artisan"
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
version: "3.0"
|
|
2
|
+
game: "hearthstone"
|
|
3
|
+
api_type: "game_data"
|
|
4
|
+
|
|
5
|
+
# Endpoint definitions
|
|
6
|
+
endpoints:
|
|
7
|
+
# Card API
|
|
8
|
+
- method_name: "search_cards"
|
|
9
|
+
path_template: "/hearthstone/cards"
|
|
10
|
+
params: ["region", "locale"]
|
|
11
|
+
namespace_type: "none"
|
|
12
|
+
description: "Search for Hearthstone cards (supports filters as kwargs)"
|
|
13
|
+
response_model: "HSCardSearch"
|
|
14
|
+
accepts_kwargs: true
|
|
15
|
+
|
|
16
|
+
- method_name: "get_card"
|
|
17
|
+
path_template: "/hearthstone/cards/{id_or_slug}"
|
|
18
|
+
params: ["region", "locale", "id_or_slug"]
|
|
19
|
+
namespace_type: "none"
|
|
20
|
+
description: "Get a Hearthstone card by ID or slug"
|
|
21
|
+
response_model: "HSCard"
|
|
22
|
+
|
|
23
|
+
# Card Back API
|
|
24
|
+
- method_name: "search_card_backs"
|
|
25
|
+
path_template: "/hearthstone/cardbacks"
|
|
26
|
+
params: ["region", "locale"]
|
|
27
|
+
namespace_type: "none"
|
|
28
|
+
description: "Search for Hearthstone card backs (supports filters as kwargs)"
|
|
29
|
+
response_model: "HSCardBackSearch"
|
|
30
|
+
accepts_kwargs: true
|
|
31
|
+
|
|
32
|
+
- method_name: "get_card_back"
|
|
33
|
+
path_template: "/hearthstone/cardbacks/{id_or_slug}"
|
|
34
|
+
params: ["region", "locale", "id_or_slug"]
|
|
35
|
+
namespace_type: "none"
|
|
36
|
+
description: "Get a Hearthstone card back by ID or slug"
|
|
37
|
+
response_model: "HSCardBack"
|
|
38
|
+
|
|
39
|
+
# Deck API
|
|
40
|
+
- method_name: "get_deck"
|
|
41
|
+
path_template: "/hearthstone/deck/{deck_code}"
|
|
42
|
+
params: ["region", "locale", "deck_code"]
|
|
43
|
+
namespace_type: "none"
|
|
44
|
+
description: "Get a Hearthstone deck by deck code"
|
|
45
|
+
response_model: "HSDeck"
|
|
46
|
+
|
|
47
|
+
- method_name: "create_deck"
|
|
48
|
+
path_template: "/hearthstone/deck"
|
|
49
|
+
params: ["region", "locale"]
|
|
50
|
+
namespace_type: "none"
|
|
51
|
+
description: "Create a Hearthstone deck (POST request)"
|
|
52
|
+
response_model: "HSDeck"
|
|
53
|
+
http_method: "POST"
|
|
54
|
+
|
|
55
|
+
# Metadata API
|
|
56
|
+
- method_name: "get_metadata"
|
|
57
|
+
path_template: "/hearthstone/metadata"
|
|
58
|
+
params: ["region", "locale"]
|
|
59
|
+
namespace_type: "none"
|
|
60
|
+
description: "Get Hearthstone metadata (all types)"
|
|
61
|
+
response_model: "HSMetadata"
|
|
62
|
+
|
|
63
|
+
- method_name: "get_metadata_type"
|
|
64
|
+
path_template: "/hearthstone/metadata/{metadata_type}"
|
|
65
|
+
params: ["region", "locale", "metadata_type"]
|
|
66
|
+
namespace_type: "none"
|
|
67
|
+
description: "Get Hearthstone metadata by type (sets, setGroups, types, rarities, classes, etc.)"
|
|
68
|
+
response_model: "HSMetadataType"
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
version: "3.0"
|
|
2
|
+
game: "sc2"
|
|
3
|
+
api_type: "community"
|
|
4
|
+
|
|
5
|
+
# Endpoint definitions
|
|
6
|
+
endpoints:
|
|
7
|
+
# Profile API
|
|
8
|
+
- method_name: "get_static_profile"
|
|
9
|
+
path_template: "/sc2/static/profile/{region_id}"
|
|
10
|
+
params: ["region", "locale", "region_id"]
|
|
11
|
+
namespace_type: "none"
|
|
12
|
+
description: "Get static profile data for a StarCraft 2 region"
|
|
13
|
+
response_model: "SC2StaticProfile"
|
|
14
|
+
|
|
15
|
+
- method_name: "get_metadata_profile"
|
|
16
|
+
path_template: "/sc2/metadata/profile/{region_id}/{realm_id}/{profile_id}"
|
|
17
|
+
params: ["region", "locale", "region_id", "realm_id", "profile_id"]
|
|
18
|
+
namespace_type: "none"
|
|
19
|
+
description: "Get metadata for a StarCraft 2 profile"
|
|
20
|
+
response_model: "SC2MetadataProfile"
|
|
21
|
+
|
|
22
|
+
- method_name: "get_profile"
|
|
23
|
+
path_template: "/sc2/profile/{region_id}/{realm_id}/{profile_id}"
|
|
24
|
+
params: ["region", "locale", "region_id", "realm_id", "profile_id"]
|
|
25
|
+
namespace_type: "none"
|
|
26
|
+
description: "Get a StarCraft 2 profile"
|
|
27
|
+
response_model: "SC2Profile"
|
|
28
|
+
|
|
29
|
+
- method_name: "get_profile_ladder_summary"
|
|
30
|
+
path_template: "/sc2/profile/{region_id}/{realm_id}/{profile_id}/ladder/summary"
|
|
31
|
+
params: ["region", "locale", "region_id", "realm_id", "profile_id"]
|
|
32
|
+
namespace_type: "none"
|
|
33
|
+
description: "Get ladder summary for a StarCraft 2 profile"
|
|
34
|
+
response_model: "SC2LadderSummary"
|
|
35
|
+
|
|
36
|
+
- method_name: "get_profile_ladder"
|
|
37
|
+
path_template: "/sc2/profile/{region_id}/{realm_id}/{profile_id}/ladder/{ladder_id}"
|
|
38
|
+
params: ["region", "locale", "region_id", "realm_id", "profile_id", "ladder_id"]
|
|
39
|
+
namespace_type: "none"
|
|
40
|
+
description: "Get a ladder for a StarCraft 2 profile"
|
|
41
|
+
response_model: "SC2Ladder"
|
|
42
|
+
|
|
43
|
+
# Ladder API
|
|
44
|
+
- method_name: "get_grandmaster_leaderboard"
|
|
45
|
+
path_template: "/sc2/ladder/grandmaster/{region_id}"
|
|
46
|
+
params: ["region", "locale", "region_id"]
|
|
47
|
+
namespace_type: "none"
|
|
48
|
+
description: "Get grandmaster leaderboard for a region"
|
|
49
|
+
response_model: "SC2GrandmasterLeaderboard"
|
|
50
|
+
|
|
51
|
+
- method_name: "get_season"
|
|
52
|
+
path_template: "/sc2/ladder/season/{region_id}"
|
|
53
|
+
params: ["region", "locale", "region_id"]
|
|
54
|
+
namespace_type: "none"
|
|
55
|
+
description: "Get current ladder season data for a region"
|
|
56
|
+
response_model: "SC2Season"
|
|
57
|
+
|
|
58
|
+
# Player API
|
|
59
|
+
- method_name: "get_player"
|
|
60
|
+
path_template: "/sc2/player/{account_id}"
|
|
61
|
+
params: ["region", "locale", "account_id"]
|
|
62
|
+
namespace_type: "none"
|
|
63
|
+
description: "Get a StarCraft 2 player by account ID"
|
|
64
|
+
response_model: "SC2Player"
|
|
65
|
+
|
|
66
|
+
# Legacy API
|
|
67
|
+
- method_name: "get_legacy_profile"
|
|
68
|
+
path_template: "/sc2/legacy/profile/{region_id}/{realm_id}/{profile_id}"
|
|
69
|
+
params: ["region", "locale", "region_id", "realm_id", "profile_id"]
|
|
70
|
+
namespace_type: "none"
|
|
71
|
+
description: "Get legacy profile data"
|
|
72
|
+
response_model: "SC2LegacyProfile"
|
|
73
|
+
|
|
74
|
+
- method_name: "get_legacy_profile_ladders"
|
|
75
|
+
path_template: "/sc2/legacy/profile/{region_id}/{realm_id}/{profile_id}/ladders"
|
|
76
|
+
params: ["region", "locale", "region_id", "realm_id", "profile_id"]
|
|
77
|
+
namespace_type: "none"
|
|
78
|
+
description: "Get legacy profile ladder data"
|
|
79
|
+
response_model: "SC2LegacyLadders"
|
|
80
|
+
|
|
81
|
+
- method_name: "get_legacy_profile_matches"
|
|
82
|
+
path_template: "/sc2/legacy/profile/{region_id}/{realm_id}/{profile_id}/matches"
|
|
83
|
+
params: ["region", "locale", "region_id", "realm_id", "profile_id"]
|
|
84
|
+
namespace_type: "none"
|
|
85
|
+
description: "Get legacy profile match history"
|
|
86
|
+
response_model: "SC2LegacyMatches"
|
|
87
|
+
|
|
88
|
+
- method_name: "get_legacy_ladder"
|
|
89
|
+
path_template: "/sc2/legacy/ladder/{region_id}/{ladder_id}"
|
|
90
|
+
params: ["region", "locale", "region_id", "ladder_id"]
|
|
91
|
+
namespace_type: "none"
|
|
92
|
+
description: "Get legacy ladder data"
|
|
93
|
+
response_model: "SC2LegacyLadder"
|
|
94
|
+
|
|
95
|
+
- method_name: "get_legacy_achievements"
|
|
96
|
+
path_template: "/sc2/legacy/data/achievements/{region_id}"
|
|
97
|
+
params: ["region", "locale", "region_id"]
|
|
98
|
+
namespace_type: "none"
|
|
99
|
+
description: "Get legacy achievements data"
|
|
100
|
+
response_model: "SC2LegacyAchievements"
|
|
101
|
+
|
|
102
|
+
- method_name: "get_legacy_rewards"
|
|
103
|
+
path_template: "/sc2/legacy/data/rewards/{region_id}"
|
|
104
|
+
params: ["region", "locale", "region_id"]
|
|
105
|
+
namespace_type: "none"
|
|
106
|
+
description: "Get legacy rewards data"
|
|
107
|
+
response_model: "SC2LegacyRewards"
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
version: "3.0"
|
|
2
|
+
game: "sc2"
|
|
3
|
+
api_type: "game_data"
|
|
4
|
+
|
|
5
|
+
# Endpoint definitions
|
|
6
|
+
endpoints:
|
|
7
|
+
# League API
|
|
8
|
+
- method_name: "get_league_data"
|
|
9
|
+
path_template: "/sc2/league/{season_id}/{queue_id}/{team_type}/{league_id}"
|
|
10
|
+
params: ["region", "locale", "season_id", "queue_id", "team_type", "league_id"]
|
|
11
|
+
namespace_type: "none"
|
|
12
|
+
description: "Get league data for a specific season, queue, team type, and league"
|
|
13
|
+
response_model: "SC2League"
|