Spécification OpenAPI & Collections API
OpenAPI 3.0
La spécification OpenAPI 3.0 complète est disponible en téléchargement. Vous pouvez l'utiliser avec des outils comme Swagger UI, Redocly, ou tout outil compatible OpenAPI.
Utilisation avec Swagger UI
Vous pouvez consulter la spécification de façon interactive à l'aide de l'éditeur Swagger en ligne :
- Accédez à editor.swagger.io
- Cliquez sur File > Import URL ou collez le contenu du fichier YAML
Utilisation avec Redocly
npx @redocly/cli preview-docs openapi.yaml
Collection Postman / Insomnia
Une collection préconfigurée avec tous les endpoints API est disponible pour importation dans Postman ou Insomnia.
Télécharger prediction-market-api.postman_collection.json
Importation dans Postman
- Ouvrez Postman
- Cliquez sur Import (en haut à gauche)
- Sélectionnez le fichier JSON téléchargé
- La collection apparaîtra avec tous les endpoints organisés par catégorie
Importation dans Insomnia
- Ouvrez Insomnia
- Cliquez sur Import depuis le tableau de bord ou File > Import
- Sélectionnez le fichier JSON téléchargé
- Toutes les requêtes seront importées
Variables de la collection
Après l'importation, mettez à jour ces variables avec vos valeurs :
| Variable | Description | Valeur par défaut |
|---|---|---|
baseUrl | URL de base de l'API | https://polymarket.sandbox.playbatman.com |
apiKey | Votre clé API opérateur | your-api-key |
marketId | Renseignée automatiquement lors de la création d'un marché | — |
outcomeId | Renseignée automatiquement lors de la création d'un marché | — |
orderId | Renseignée automatiquement lors du placement d'un ordre | — |
categoryId | À définir manuellement après la création d'une catégorie | — |
Variables renseignées automatiquement
La collection inclut des scripts de test qui définissent automatiquement les variables :
- Create Market définit
marketIdetoutcomeIdà partir de la réponse - Place Order définit
orderIdà partir de la réponse
Cela vous permet d'exécuter des requêtes en séquence sans copier manuellement les identifiants.
Organisation des requêtes
La collection est organisée en dossiers correspondant aux sections de l'API :
| Dossier | Requêtes |
|---|---|
| Health | Health Check, Ready Check |
| Categories | Create, List, Get |
| Markets | Create, List, Get, Update, Open, Suspend, Resume, Close, Resolve, Cancel |
| Orders | Place (Limit Buy, Limit Sell, Market Buy), Get, List, List by Player, Cancel |
| Positions | Get All, Get by Market |
| Trades | List All, List by Market |
| Market Data | Order Book, Market Prices, Outcome Price |
| Stats | Overview |
| Settlements | Settle, Status, Retry, Get All, Get by Market |