Skip to main content
POST
/
v1
/
workbooks
/
{id}
/
calc
JavaScript
import Grid from '@grid-is/api';

const client = new Grid({
  apiKey: 'My API Key',
});

const response = await client.workbooks.calc('id', { read: ['A1'] });

console.log(response);
{}
Use this endpoint if you need detailed cell objects that include raw values, value types, format strings, and cell positional offsets. If you only need cell values, try the values endpoint.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
read
string[]
required

A1-style cell reference, cell range, or formula that references cells in a sheet. References can be relative, mixed, or absolute. References may include a sheet prefix.

{
  "read": [
    "A1",
    "Sheet1!A1:B2",
    "'Loan Calculator'!C32",
    "$A$1",
    "=10*10",
    "=SUM(A:A)"
  ],
}
​
apply
Apply · object

Map of cell references to values. The values are written to cells in the spreadsheet before performing the read operation. You can write numbers, strings, and booleans. Values applied within a request are temporary and affect only that specific request. They are not permanently written to the original spreadsheet.

{
  "apply": { "A1": 10, "A2": 2.718, "A3": "Total", "A4": true, "A5": null },
  // ...
}
Example:
{
  "A1": 100,
  "A2": 2.718,
  "A3": "Total",
  "A4": true
}

Response

Successful Response

Response type returned by the for /calc query endpoint.

​
{key}
ReadValue · object
  • ReadValue · object
  • ReadValue · object[]
Example:
{
  "formatted": "€6,378.32",
  "offset": [0, 0],
  "type": "number",
  "value": 6378.32
}