> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sparkle.bot/llms.txt
> Use this file to discover all available pages before exploring further.
# Predictions
> Gérez les prédictions sur votre chaîne Twitch
### `getPredictions`
Récupère la liste des prédictions sur la chaîne.
```javascript theme={null}
const predictions = await ctx.twitch.predictions.getPredictions()
```
**Arguments**
La pagination pour récupérer les prédictions suivantes.
**Type de retour**
La méthode retourne un objet contenant les données des prédictions et un curseur de pagination.
### `getPredictionsByIds`
Récupère les prédictions par ID.
```javascript theme={null}
const predictionIds = ["prediction_id_1", "prediction_id_2"]
const predictions =
await ctx.twitch.predictions.getPredictionsByIds(predictionIds)
```
**Arguments**
Un tableau d'identifiants de prédictions.
**Type de retour**
La méthode retourne un tableau d'objets [Prediction](#prediction).
### `getPredictionById`
Récupère une prédiction par ID.
```javascript theme={null}
const predictionId = "prediction_id"
const prediction = await ctx.twitch.predictions.getPredictionById(predictionId)
```
**Arguments**
L'ID de la prédiction à récupérer.
**Type de retour**
La méthode retourne un objet [Prediction](#prediction).
### `createPrediction`
Crée une nouvelle prédiction sur la chaîne.
```javascript theme={null}
const data = {
title: "Titre de la prédiction",
outcomes: ["Option 1", "Option 2"],
}
const prediction = await ctx.twitch.predictions.createPrediction(data)
```
**Arguments**
Les données de la prédiction à créer.
**Type de retour**
La méthode retourne un objet [Prediction](#prediction).
### `lockPrediction`
Verrouille une prédiction existante.
```javascript theme={null}
const predictionId = "prediction_id"
const lockedPrediction =
await ctx.twitch.predictions.lockPrediction(predictionId)
```
**Arguments**
L'ID de la prédiction à verrouiller.
**Type de retour**
La méthode retourne un objet [Prediction](#prediction).
### `resolvePrediction`
Résout une prédiction existante.
```javascript theme={null}
const predictionId = "prediction_id"
const outcomeId = "outcome_id"
const resolvedPrediction = await ctx.twitch.predictions.resolvePrediction(
predictionId,
outcomeId,
)
```
**Arguments**
L'ID de la prédiction à résoudre.
L'ID de l'issue à déclarer comme gagnante.
**Type de retour**
La méthode retourne un objet [Prediction](#prediction).
### `cancelPrediction`
Annule une prédiction existante.
```javascript theme={null}
const predictionId = "prediction_id"
const canceledPrediction =
await ctx.twitch.predictions.cancelPrediction(predictionId)
```
**Arguments**
L'ID de la prédiction à annuler.
**Type de retour**
La méthode retourne un objet [Prediction](#prediction).
## Types
Liste des types de retour des méthodes de l'objet `Predictions`.
### Prediction
L'identifiant de la prédiction.
Le titre de la prédiction.
Le statut de la prédiction.
Le temps en secondes après lequel la prédiction sera automatiquement
verrouillée.
La date de création de la prédiction.
La date de fin de la prédiction.
La date de verrouillage de la prédiction.
Un tableau d'objets [PredictionOutcome](#predictionoutcome) représentant les
résultats possibles de la prédiction.
L'issue gagnante de la prédiction, si résolue.
L'ID de l'issue gagnante de la prédiction, si résolue.
### PredictionOutcome
La couleur associée à l'issue de la prédiction.
L'identifiant de l'issue de la prédiction.
Le titre de l'issue de la prédiction.
Un tableau d'objets [TopPredictor](#toppredictor) représentant les principaux
prédicteurs de cette issue.
Le nombre total de points de chaîne pariant sur cette issue.
Le nombre total d'utilisateurs ayant parié sur cette issue.
### TopPredictor
L'identifiant de l'utilisateur principal parieur.
Le nom d'utilisateur de l'utilisateur principal parieur.
Le nom d'affichage de l'utilisateur principal parieur.
Le nombre de points de chaîne utilisés par l'utilisateur principal parieur.
Le nombre de points de chaîne gagnés par l'utilisateur principal parieur.