> For the complete documentation index, see [llms.txt](https://docs.zebec.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zebec.io/zebec-evm/zebec-evm-sdk/zebec-stream-client/getting-stream-details.md).

# Getting Stream Details

To get the details of a stream, use the `getStreamDetails()` method:

```javascript
const streamBytes = await zebecClient.getLatestStreamBytes(sender.address); // gets the last stream bytes of "sender.address"
const streamDetails = await zebecClient.getStreamDetails(streamBytes);

console.log("Stream Details:", streamDetails);
```

For more details and methods, please refer to the source code or documentation of the`ZebecStreamClient` class.

The `getStreamDetails` function returns an object containing the following stream details:

* `receiver` (type: `string`): address of the receiver of the stream.
* `token` (type: `string`): address of the token being streamed
* `startTime` (type: `BigNumber`): The timestamp when the stream started.
* `endTime` (type: `BigNumber`): The timestamp when the stream is scheduled to end.
* `amounts` (type: `Core.AmountStructOutput`):&#x20;

  An object containing various amounts associated with the stream. It is a type with the following sub-properties:

  * `streamAmount` (BigNumber): The total amount allocated to the stream.
  * `releasedAmount` (BigNumber): The amount that has been released to the recipient.
  * `unlockedAmount` (BigNumber): The amount that is currently unlocked and can be withdrawn.
  * `pausedAmount` (BigNumber): The amount that is currently paused and cannot be withdrawn.
* `pausedTime` (type: `BigNumber`): The timestamp when the stream was paused, if it has been paused.
* `withdrawTime` (type: `BigNumber`): The timestamp when the stream was withdrawn, if it has been withdrawn.
* `originZebecWallet` (type: `string`): The wallet or address from which the stream originates.
* `canceled` (type: `boolean`): A boolean value indicating whether the stream has been canceled (`true`) or not (`false`).
* `paused` (type: `boolean`): A boolean value indicating whether the stream is currently paused (`true`) or not (`false`).
* `streamParam` (type: `number`): A numeric value representing a parameter of the stream.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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://docs.zebec.io/zebec-evm/zebec-evm-sdk/zebec-stream-client/getting-stream-details.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.
