---
title: "Download Object"
url: https://docs.catalyst.zoho.com/en/sdk/flutter/v2/cloud-scale/stratus/download-object/
description: "This page lists the Flutter SDK methods to download an object to the bucket."
last_updated: 2026-09-08T11:07:33Z
service: Cloud Scale
type: general
related_links:
  - name: "Stratus Component Help Documentation"
    url: /en/cloud-scale/help/stratus/introduction
  - name: "Download an Object"
    url: /en/cloud-scale/help/stratus/objects/manage-object/download-object/
  - name: "Java SDK"
    url: /en/sdk/java/v1/cloud-scale/stratus/range-download/
  - name: "JavaScript SDK Documentation"
    url: /en/sdk/javascript/v1/overview/
  - name: "Python SDK"
    url: /en/sdk/python/v1/cloud-scale/stratus/range-download/
  - name: "iOS SDK"
    url: /en/sdk/ios/v2/cloud-scale/stratus/download-object/
  - name: "Android SDK"
    url: /en/sdk/android/v2/cloud-scale/stratus/download-object/
  - name: "REST API"
    url: /en/api/code-reference/cloud-scale/stratus/upload-object/#DownloadObject
---

# Download Object

This SDK method will allow you to download the object. The operation will retuen an input stream.

**Parameters Used**

<table class="content-table">
	<thead>
		<tr>
			<th class="w20p">Parameter Name</th>
      <th class="w20p">Data Type</th>
      <th class="w60p">Definition</th>
		</tr>
	</thead>
	<tbody>
    <tr>
      <td>`pathToDownload`</td>
      <td>**String**</td>
      <td>A **mandatory** parameter. Will hold the [path](https://docs.catalyst.zoho.com/en/cloud-scale/help/stratus/objects/introduction/#path) where the object needs to be downloaded.</td>
    </tr>
    <tr>
      <td>`newObjectName`</td>
      <td>**String**</td>
      <td>An **optional** parameter. Will hold the name of the object that you provide while being downloaded. If you do not provide this value, then the object will be downloaded by its original name.</td>
    </tr>
		<tr>
			<td>`versionId`</td>
      <td>**String**</td>
			<td>An **optional** parameter. If [Versioning](https://docs.catalyst.zoho.com/en/cloud-scale/help/stratus/stratus-config/general-settings/#versioning) is enabled for the bucket, it will hold the unique version ID of the required object's version.</td>
		</tr>
    <tr>
			<td>`fromCache`</td>
      <td>**Boolean**</td>
			<td>
        <ul>
          <li>An **optional** parameter. To be used to specify whether this file has to be retrieved from the cache or not.</li>
          <li>**Default Value**: false.</li>
        </ul>
      </td>
		</tr>
    <tr>
			<td>`progress`</td>
      <td>**Function(int, int, Double)?**</td>
			<td>A callback function that can provide progess information about the object download</td>
		</tr>
	</tbody>
</table>

```javascript
try {
    ZCatalystBucket bucket = stratus.bucket("testing");
    var (response, object) = await bucket.getObject("SunSet.jpeg");
    final downloadsDir = await getExternalStorageDirectory();
    final filePath = downloadsDir!.absolute.path;
    var fileResponse = await object.download(
        pathToDownload: filePath,
        onProgress: (bytesWritten, contentLength, percentage) {
            print("Downloaded Percentage: $percentage");
        },
    );
    print("Download Status: ${fileResponse.statusCode}");
    OpenFile.open(filePath + '/SunSet.jpeg');
}
on ZCatalystException catch (ex) {
    print(ex.toString());
}
```