Skip to main content
Version: v0.2b

Depot Schema

Model

Depot

Ƭ Depot: Object

The depot data. All depots in the API will have this format.

Example

{
"id": "depots/zeOCJaJCzZhpKVCVAC9o",
"name": "Depot 1",
}

Type declaration

NameTypeDescription
idDepotIdThis depot's unique identifier in the API.
namestringThis depot's name.

Identifier

DepotId

Ƭ DepotId: `depots/${string}`

A depot id is a string that is unique for a depot. It is used to identify the depot in the API.

Example

"depot/0xBYy4MYt4piMCSQEsts"