Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ratakondalaarun/tmdb_api
Dart client library for themoviedb.org(TMDB) API
https://github.com/ratakondalaarun/tmdb_api
dart dart-package dartlang flutter hacktoberfest movie-api pub themoviedb tmdb tmdb-api tmdb-client-library tv-api
Last synced: about 1 month ago
JSON representation
Dart client library for themoviedb.org(TMDB) API
- Host: GitHub
- URL: https://github.com/ratakondalaarun/tmdb_api
- Owner: RatakondalaArun
- License: gpl-3.0
- Created: 2020-02-13T17:21:58.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-02-03T22:17:57.000Z (11 months ago)
- Last Synced: 2024-11-01T02:22:02.260Z (about 2 months ago)
- Topics: dart, dart-package, dartlang, flutter, hacktoberfest, movie-api, pub, themoviedb, tmdb, tmdb-api, tmdb-client-library, tv-api
- Language: Dart
- Homepage: https://pub.dev/packages/tmdb_api
- Size: 1.26 MB
- Stars: 19
- Watchers: 1
- Forks: 27
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# tmdb_api
[](https://github.com/RatakondalaArun/tmdb_api/actions/workflows/analysis.yml)
[](https://github.com/RatakondalaArun/tmdb_api/actions/workflows/ci.yml)
[](https://pub.dartlang.org/packages/tmdb_api)
[](https://pub.dev/packages/lint)
A TheMovieDatabase client library for dart.
To know more about TMDB visit [*offical site*](https://www.themoviedb.org/)
## Getting started
1) **Adding as dependencies**
[Pub.dev's installation guide](https://pub.dev/packages/tmdb_api#-installing-tab-)
Add this to your package's pubspec.yaml file:
```yaml
dependencies:
tmdb_api: latest //visit tmdb for latest version number
```
2) **Import it**
Now in your Dart code, you can use:
```dart
import 'package:tmdb_api/tmdb_api.dart';
```
3) **Create Instance**
Now you need to create instance for `TMDB` and `ApiKeys` with your api keys.
```dart
final tmdbWithCustomLogs = TMDB( //TMDB instance
ApiKeys('Your API KEY', 'apiReadAccessTokenv4'),//ApiKeys instance with your keys,
);
```
4) **Configuring console logs**
There are 3 logconfigs presets avaliable.
- `ConfigLogger.showAll()`: development use.
- `ConfigLogger.showRecommended()`: development use.
- `ConfigLogger.showNone()`: production use.
You can add any off this presets to `logConfig` named parameter of `TMDB` instance
**Custom Logs**
```dart
final tmdbWithCustomLogs = TMDB(
ApiKeys('Your API KEY', 'apiReadAccessTokenv4'),
logConfig: ConfigLogger(
showLogs: true,//must be true than only all other logs will be shown
showErrorLogs: true,
),
);
```
## Example
For getting Trending movies
```dart
Map result = await tmdb.v3.trending.getTrending(mediaType = MediaType.all,timeWindow = TimeWindow.day);
```
### Custom Dio instance
```dart
final tmdbWithCustomLogs = TMDB(
ApiKeys('Your API KEY', 'apiReadAccessTokenv4'),
dio:Dio()// your own dio instance
);
```
### Setting Default api data language
```dart
final tmdbWithCustomLogs = TMDB(
ApiKeys('Your API KEY', 'apiReadAccessTokenv4'),
defaultLanguage:'en-US'// sets default language for all supported endpoints
);
```
### Adding Interceptors
```dart
final tmdbWithCustomLogs = TMDB(
ApiKeys('Your API KEY', 'apiReadAccessTokenv4'),
interceptors:Interceptors()..add(/*your interceptor*/)
);
```
or
```dart
final customDio = Dio();
customDio.interceptors.add(/*your interceptor*/)
final tmdbWithCustomLogs = TMDB(
ApiKeys('Your API KEY', 'apiReadAccessTokenv4'),
dio:dio
);
```
note:*Use interceptors only when you are not using a custom `Dio` instance*.
## For more API documentation
visit [offical API documentation](https://developers.themoviedb.org/3/getting-started/introduction)