Get Named Ranges on an Excel Workbook – Aspose.Cells Cloud API

This REST API returns information about named ranges defined within worksheets.

REST API

GET https://api.aspose.cloud/v3.0/cells/{name}/worksheets/ranges

Request parameters

Parameter Name	Type	Location	Description
name	string	Path	The name of the Excel document.
folder	string	Query string	The folder that contains the document.
storageName	string	Query string	The storage name where the document resides.

Status Codes

Status Code	Description
200	OK – The request succeeded and named ranges are returned.
401	Unauthorized – Invalid or missing authentication token.
404	Not Found – The specified workbook or named range does not exist.
500	Internal Server Error – An unexpected error occurred on the server.

The OpenAPI Specification defines a publicly accessible programming interface that lets you perform REST interactions directly from a web browser.

You can use the cURL command‑line tool to call Aspose.Cells web services. The example below demonstrates how to retrieve named ranges using cURL.

Request

curl -v "https://api.aspose.cloud/v3.0/cells/test.xlsx/worksheets/ranges" \
  -X GET \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt token>"

Response

{
  "Ranges": {
    "RangeList": [
      {
        "ColumnCount": 7,
        "ColumnWidth": 8.428571428571429,
        "FirstColumn": 1,
        "FirstRow": 9,
        "Name": "data",
        "RefersTo": "=Sheet1!$B$10:$H$10",
        "RowCount": 1,
        "RowHeight": 15,
        "Worksheet": "Sheet1"
      }
    ]
  },
  "Code": 200,
  "Status": "OK"
}

Cloud SDK Family

Using an SDK is the fastest way to integrate this functionality. SDKs handle low‑level details so you can focus on your business logic. See the GitHub repository for a complete list of Aspose.Cells Cloud SDKs.

The following code examples demonstrate how to call Aspose.Cells web services using various SDKs:

Get cells data based on named range