You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/usage.md
+20-27Lines changed: 20 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,18 +55,11 @@ specific providers:
55
55
|`offset`| Basic "pagination". Offset for the first returned result, i.e. how many first entries should be skipped. Everything is handled on API side, this library isn't doing any filtering. |
56
56
| `providers` | Providers (like Netflix, Amazon Prime Video) for which offers should returned. Requires 3-letter "short name". Check [Provider codes](caveats.md#provider-codes) page for an example of how you can get that value.
57
57
58
-
Each function can raise two exceptions:
59
-
60
-
| Exception | Cause |
61
-
|-----------|-------|
62
-
|[`JustWatchHttpError`][simplejustwatchapi.exceptions.JustWatchHttpError]| JustWatch API responded with non-`2xx` code. |
63
-
|[`JustWatchApiError`][simplejustwatchapi.exceptions.JustWatchApiError]| JSON response from JustWatch API contains errors (e.g., due to invalid language or country code). If this exception is raised, then API responded with `2xx` code. |
64
-
65
58
66
59
### Search for a title
67
60
68
-
[`search`][simplejustwatchapi.justwatch.search] function allows for searching entries
69
-
based on a given title.
61
+
[`search`][simplejustwatchapi.justwatch.search]{data-preview} function allows for
62
+
searching entries based on a given title.
70
63
71
64
```python
72
65
from simplejustwatchapi import search
@@ -98,8 +91,8 @@ Example function call and its output is in
98
91
99
92
### Popular titles
100
93
101
-
[`popular`][simplejustwatchapi.justwatch.popular] function allows for getting a list of
102
-
currently popular titles.
94
+
[`popular`][simplejustwatchapi.justwatch.popular]{data-preview} function allows for
95
+
getting a list of currently popular titles.
103
96
104
97
```python
105
98
from simplejustwatchapi import popular
@@ -128,8 +121,8 @@ Example function call and its output is in
128
121
129
122
### Details for a title based on its ID
130
123
131
-
[`details`][simplejustwatchapi.justwatch.details] function allows for looking up details
132
-
for a single entry via its node ID.
124
+
[`details`][simplejustwatchapi.justwatch.details]{data-preview} function allows for
125
+
looking up details for a single entry via its node ID.
133
126
134
127
```python
135
128
from simplejustwatchapi import details
@@ -168,8 +161,8 @@ Example function call and its output is in
168
161
169
162
### Details for all seasons of a TV show
170
163
171
-
[`seasons`][simplejustwatchapi.justwatch.seasons] function allows for looking up details
172
-
for all seasons of a TV show based on its node ID.
164
+
[`seasons`][simplejustwatchapi.justwatch.seasons]{data-preview} function allows for
165
+
looking up details for all seasons of a TV show based on its node ID.
173
166
174
167
```python
175
168
from simplejustwatchapi import seasons
@@ -189,8 +182,8 @@ Example function call and its output is in
189
182
190
183
### Details for all episodes of a TV show
191
184
192
-
[`episodes`][simplejustwatchapi.justwatch.episodes] function allows for looking up
193
-
details for all episodes of a single TV show season based on its node ID.
185
+
[`episodes`][simplejustwatchapi.justwatch.episodes]{data-preview} function allows for
186
+
looking up details for all episodes of a single TV show season based on its node ID.
194
187
195
188
```python
196
189
from simplejustwatchapi import episodes
@@ -215,9 +208,9 @@ Example function call and its output is in
215
208
216
209
### Get offers for multiple countries for a single title
217
210
218
-
[`offers_for_countries`][simplejustwatchapi.justwatch.offers_for_countries] function
219
-
allows for looking up offers for a single entry, but for multiple countries at once.
|[`JustWatchHttpError`][simplejustwatchapi.exceptions.JustWatchHttpError]| JustWatch API responded with non-`2xx` code. |
280
-
|[`JustWatchApiError`][simplejustwatchapi.exceptions.JustWatchApiError]| JSON response from JustWatch API contains errors,<br>even though the API responded with a `2xx` status code. |
|[`JustWatchHttpError`][simplejustwatchapi.exceptions.JustWatchHttpError]{data-preview}| JustWatch API responded with non-`2xx` code. |
273
+
|[`JustWatchApiError`][simplejustwatchapi.exceptions.JustWatchApiError]{data-preview}| JSON response from JustWatch API contains errors,<br>even though the API responded with a `2xx` status code. |
281
274
282
275
You can check [Exceptions](API Reference/exceptions.md) page for more details.
0 commit comments