Entwicklerdokumentation

API-Arbeitsbereich
https://api.rentron.xyz/v1
OpenAPI-Schema

Bestellungen auflisten

// GET

Produktions-API

Bestellungen auflisten

Bestellungen von neu nach alt lesen, mit undurchsichtigem Cursor als Seitenwechsel.

GET /v1/energy/orders?limit=20&cursor=...
Auf dieser Seite

Der Endpunkt liefert ausschließlich Bestellungen des Kontos, zu dem die Zugangsdaten gehören.

Query-Parameter

Parameter Typ Standard Beschreibung
limit integer 20 Seitengröße von 1 bis 100.
cursor string Undurchsichtiger Wert aus dem vorherigen next_cursor.

Die Signatur umfasst die exakte Query-Zeichenkette samt führendem ?. Ordnen oder kodieren Sie sie nach dem Signieren nicht neu.

Antwort 200

{"items":[{"id":"7c0c9a54-517c-4bbb-a946-bf14bf86c113","client_request_id":"order-1042","address":"TJRabPrwbZy45sbavfcjinPJC18kjpRTv8","energy":65000,"duration_minutes":60,"total_trx":"3.200000","status":"created","lifecycle_final":false,"delivery_final":false,"created_at":1784376000,"updated_at":1784376000,"energy_usable":false}],"next_cursor":"opaque-value"}

items ist nach Alter sortiert, die neueste Bestellung zuerst. Auf der letzten Seite fehlt next_cursor vollständig in der Antwort, statt als null zu kommen: hören Sie auf, sobald der Schlüssel fehlt — eine Prüfung auf ein ausdrückliches null erkennt das Ende der Liste nie. Felder innerhalb eines Eintrags verhalten sich genauso: die Bestellung oben trägt weder rental_expires_at noch failure, weil sie für beides noch keinen Wert hat.

Jeder Eintrag trägt die vollständige Form einer Bestellung, einschließlich status (created, executing, available, delivered, rental_finished, failed, rental_interrupted), energy_usable und rental_expires_at. Um zu entscheiden, welche Adressen gerade Energy ausgeben können, filtern Sie auf energy_usable, nicht auf status == "delivered". Eine Bestellung in available ist bereits nutzbar, und ihr bezahltes Fenster läuft schon. Eine Bestellung, deren Fenster abgelaufen ist, ist nicht mehr nutzbar, während ihr Status noch delivered anzeigt. Siehe Bestellung abrufen.

Regeln für den Cursor

  • Geben Sie den Cursor unverändert zurück.
  • Dekodieren oder erzeugen Sie ihn nie selbst.
  • Ein Cursor gehört fest zu seinem Konto und seiner Ressource.
  • Ein Cursor hört 24 Stunden nach seiner Ausgabe auf zu funktionieren. Heben Sie keinen auf, um einen Durchlauf am nächsten Tag fortzusetzen; beginnen Sie ohne Cursor neu.
  • Ein ungültiger, veränderter, abgelaufener oder fremder Cursor liefert 400 mit pagination_cursor_invalid.