# Retrieve a supply by id

Retrieve a specific supply offer by its unique identifier. A Supply represents an offer created by a user to exchange a specific amount of sparks of one asset for a desired amount of another asset.

**Note:** Supplies cannot be ordered by the ExchangeRate field.

📘[ Learn more ](/resources/using-the-teos-api/concepts/supply.md)about supplies.

#### Request Endpoint:

```http
GET /v1.0/v1.0/Supplies({key})
```

#### Parameters

| **Name** | **Description**                                                                                                              |
| -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| key      | string (path) — The requested supply identifier. Example: 0x0086D7926780773AD29E00013935945BCF0F92023FEA00010E21EA5700000161 |

Supported OData query options: Expand, Select.

#### Responses

**Code:** 200\
**Description:** The supply was successfully retrieved.\
**Media type:** `application/json` 

#### Example Response Body:

In EVM-compatible networks (e.g., Sparknet, Ethereum, and Polygon), the "OriginatorAddress" and "ReceiverAddress" are 42 characters long. In non-EVM networks, the address length may differ. For example, on Internet Computer, it is 63 characters.

```json
{
  "Id": "string",
  "ExtReference": "string",
  "OriginatorAddress": "string",
  "ReceiverAddress": "string",
  "UniqueAssetIdOffered": "string",
  "UniqueAssetIdDesired": "string",
  "TotalAmount": "string",
  "RemainingAmount": "string",
  "ExchangeRate": "string",
  "TakeAll": true,
  "ExpiryBlock": "string",
  "ExpiryTime": "2025-10-08T09:16:23.146Z",
  "CreatedOnBlock": "string",
  "CreatedInBlockchainOn": "2025-10-08T09:16:23.146Z",
  "CreatedOn": "2025-10-08T09:16:23.146Z",
  "UpdatedOn": "2025-10-08T09:16:23.146Z"
}
```

#### Response Variables Description:

| **Field**             | **Type** | **Description**                                                         |
| --------------------- | -------- | ----------------------------------------------------------------------- |
| Id                    | string   | Unique identifier of the supply.                                        |
| ExtReference          | string   | Optional external reference for the supply.                             |
| OriginatorAddress     | string   | Wallet address of the issuer/originator of the supply.                  |
| ReceiverAddress       | string   | Wallet address of the receiver of the desired asset.                    |
| UniqueAssetIdOffered  | string   | ID of the asset offered for exchange.                                   |
| UniqueAssetIdDesired  | string   | ID of the asset desired in exchange.                                    |
| TotalAmount           | string   | Total amount of the offered asset in sparks.                            |
| RemainingAmount       | string   | Remaining amount of the offered asset available for exchange.           |
| ExchangeRate          | string   | Amount of desired asset received per 1 spark of offered asset.          |
| TakeAll               | boolean  | Indicates if the whole offered amount should be taken in one iteration. |
| ExpiryBlock           | string   | Blockchain block number when the supply expires.                        |
| ExpiryTime            | string   | Date and time when the supply expires.                                  |
| CreatedOnBlock        | string   | Blockchain block number when the supply was created.                    |
| CreatedInBlockchainOn | string   | Timestamp when the supply was written to blockchain.                    |
| CreatedOn             | string   | Timestamp when the supply was created in the TEOS platform.             |
| UpdatedOn             | string   | Timestamp of the last update of the supply.                             |

#### Response Codes:

| **Code** | **Description**                                     |
| -------- | --------------------------------------------------- |
| 200      | Supply successfully retrieved.                      |
| 400      | The request is invalid. Error details are included. |
| 401      | Unauthorized                                        |
| 404      | The supply does not exist.                          |

<br>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://teos-docs.coreledger.net/guides/supplies/retrieve-a-supply-by-id.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.