Authentifizierung
Die CoinBoss API ist öffentlich. Für den Aufruf der Datenendpunkte sind weder ein Konto noch ein API-Schlüssel erforderlich.
Kein Schlüssel erforderlich
Jeder Endpunkt im Katalog lässt sich mit einem einfachen HTTPS GET aufrufen. Anonyme Anfragen sind je IP-Adresse begrenzt: 1200 Anfragen pro Minute.
curl -s "https://www.coinboss.com/api/sd/oi?coin=BTC"Optionaler API-Schlüssel
Wenn sich mehrere Ihrer Dienste eine IP-Adresse teilen oder Sie aus einem Netzwerk mit wechselnder Adresse aufrufen, können Sie in Ihrem Konto einen Schlüssel erstellen und ihn im Header CB-API-KEY senden. Eine Anfrage mit gültigem Schlüssel wird dem Schlüssel statt der IP-Adresse angerechnet.
- Schlüssel werden auf der Seite „API-Schlüssel“ Ihres Kontos erstellt und widerrufen. Eine verifizierte E-Mail-Adresse ist erforderlich.
- Der vollständige Schlüssel wird nur einmal angezeigt, nämlich bei der Erstellung. Gespeichert wird lediglich ein Hash, daher kann er nicht erneut angezeigt werden.
- Jedes Konto kann bis zu fünf aktive Schlüssel besitzen.
- Ein unbekannter oder widerrufener Schlüssel wird ignoriert: Die Anfrage wird als anonym bedient und der IP-Adresse angerechnet.
Anfrage mit Schlüssel
curl -s "https://www.coinboss.com/api/sd/oi?coin=BTC" \
-H "CB-API-KEY: $COINBOSS_API_KEY"Rate-Limit-Stufen
Alle Stufen liefern dieselben Daten. Während der aktuellen kostenlosen Phase werden anonymer Traffic und jeder Schlüssel mit der höchsten Stufe bedient.
| Stufe | Anfragen pro Minute | |
|---|---|---|
| hobbyist | 30 | |
| startup | 80 | |
| standard | 300 | |
| professional | 1200 | gilt derzeit für alle |
Schlüssel sicher aufbewahren
- Behandeln Sie einen Schlüssel wie ein Passwort. Bewahren Sie ihn in einer Umgebungsvariable oder einem Secret-Store auf, nicht im Quellcode.
- Betten Sie keinen Schlüssel in eine Webseite, eine Browsererweiterung oder eine mobile App ein. Alles, was an einen Client ausgeliefert wird, können dessen Nutzer auslesen. Rufen Sie die API von Ihrem Server aus auf oder anonym aus dem Browser.
- Widerrufen Sie einen Schlüssel, sobald Sie vermuten, dass er offengelegt wurde, und erstellen Sie einen neuen.
- CoinBoss fragt niemals nach API-Schlüsseln von Börsen. Die Daten werden über öffentliche Börsenendpunkte erhoben; Zugangsdaten für Börsen werden von dieser API weder benötigt noch akzeptiert.
Aufruf aus dem Browser
Die Antworten enthalten Access-Control-Allow-Origin: *, sodass sich die Datenendpunkte von jedem Web-Origin aus aufrufen lassen. Die Header X-Request-Id, X-Cache und X-RateLimit-* sind für Skripte lesbar.
Konto-Endpunkte
Endpunkte unter /api/user und /api/auth gehören zum angemeldeten Bereich der Website (Watchlists, Einstellungen, Schlüsselverwaltung). Sie verwenden die Sitzung der Website, sind nicht Teil der öffentlichen Daten-API und werden nicht im Katalog aufgeführt.