Skip to content

Deel: List equity grant valuations

Deel equityTokens.listEquityValuations: arguments, response, policy and SDK examples.

← Equity tokens operations · Get started

Operation deel.equitytokens_listequityvaluations_v2026_09_09

Provider route: GET /equity-valuations. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["equityTokens"]["listEquityValuations"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.equityTokens.listEquityValuations(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_deel import DeelIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.equity_tokens.list_equity_valuations(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.limitintegerOptionalDefault: 50
Maximum: 100
Minimum: 1
query.cursorstringOptionalMaximum length: 2048
query.employee_grant_numberstringOptionalMaximum length: 100
query.grant_date_fromstringOptionalFormat: date
query.grant_date_tostringOptionalFormat: date

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand List equity grant valuations — 200 response body

Referenced models: List equity grant valuations — 200 response body

List equity grant valuations — 200 response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentPage of grant valuation records, one per grant occurrence.
data[]ModelEach itemExpand List equity grant valuations — 200 response body — data item
has_morebooleanRequired within parentWhether another page of results is available.
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor for the next page. Null when has_more is false.
next_cursor (anyOf 2)nullAlternativeCursor for the next page. Null when has_more is false.

Referenced models: List equity grant valuations — 200 response body — data item

List equity grant valuations — 200 response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
amortization_methodstringRequired within parentAmortization method (e.g. Straight-Line), as reported by the ingested file.
award_typestringRequired within parentAward type (e.g. Restricted Stock - Standard), as reported by the ingested file.
created_atstringRequired within parentTimestamp this record was first ingested.
Format: date-time
dividend_yield_percentJSONRequired within parent
dividend_yield_percent (anyOf 1)JSONAlternative
dividend_yield_percent (anyOf 1) (anyOf 1)numberAlternativeDividend yield, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows).
Format: double
dividend_yield_percent (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
dividend_yield_percent (anyOf 2)nullAlternativeDividend yield, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows).
Format: double
dividend_yield_typeJSONRequired within parent
dividend_yield_type (anyOf 1)stringAlternativeDividend yield type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).
dividend_yield_type (anyOf 2)nullAlternativeDividend yield type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).
employee_grant_numberstringRequired within parentShareworks grant number for this employee, as reported by the ingested file.
expected_lifeJSONRequired within parent
expected_life (anyOf 1)JSONAlternative
expected_life (anyOf 1) (anyOf 1)numberAlternativeExpected life of the award (years), as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).
Format: double
expected_life (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expected_life (anyOf 2)nullAlternativeExpected life of the award (years), as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).
Format: double
expected_life_typeJSONRequired within parent
expected_life_type (anyOf 1)stringAlternativeExpected life type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).
expected_life_type (anyOf 2)nullAlternativeExpected life type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).
expense_amortization_start_datestringRequired within parentExpense amortization start date, as reported by the ingested file.
Format: date
expense_valuation_modelstringRequired within parentExpense valuation model (e.g. Black-Scholes), as reported by the ingested file.
fair_value_per_shareJSONRequired within parent
fair_value_per_share (anyOf 1)numberAlternativeFair market value per share, as reported by the ingested file.
Format: double
fair_value_per_share (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
forfeiture_rate_calculation_methodstringRequired within parentForfeiture rate calculation method, as reported by the ingested file.
forfeiture_rate_percentJSONRequired within parent
forfeiture_rate_percent (anyOf 1)numberAlternativeForfeiture rate, stored as the percent NUMBER itself (e.g. 5.25 means 5.25%), NOT a fraction. See parseShareworksPercent.
Format: double
forfeiture_rate_percent (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
grant_datestringRequired within parentDate the grant was issued, as reported by the ingested file.
Format: date
grant_namestringRequired within parentGrant name, as reported by the ingested file.
grant_priceJSONRequired within parent
grant_price (anyOf 1)numberAlternativeStrike/grant price per unit, as reported by the ingested file.
Format: double
grant_price (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
idstringRequired within parentThe unique identifier of the record.
Format: uuid
last_seen_dataset_idJSONRequired within parent
last_seen_dataset_id (anyOf 1)stringAlternativeIdentifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.
Format: uuid
last_seen_dataset_id (anyOf 2)nullAlternativeIdentifier of the most recent ingested dataset in which this record still appeared. Null for records ingested before dataset tracking began.
Format: uuid
market_priceJSONRequired within parent
market_price (anyOf 1)numberAlternativeMarket price per unit, as reported by the ingested file.
Format: double
market_price (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
occurrence_indexJSONRequired within parent
occurrence_index (anyOf 1)integerAlternativeDiscriminates several records the source file reports for the same natural key. Starts at 1, in the order the rows appear in the file.
occurrence_index (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
original_grantedJSONRequired within parent
original_granted (anyOf 1)numberAlternativeOriginal granted share count, as reported by the ingested file.
Format: double
original_granted (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
original_performance_ruleJSONRequired within parent
original_performance_rule (anyOf 1)stringAlternativeOriginal performance rule, as reported by the ingested file. Sparsely populated (measured: 25 of 15,090 real rows).
original_performance_rule (anyOf 2)nullAlternativeOriginal performance rule, as reported by the ingested file. Sparsely populated (measured: 25 of 15,090 real rows).
original_vest_dateJSONRequired within parent
original_vest_date (anyOf 1)stringAlternativeOriginal vest date, as reported by the ingested file. Sparsely populated (measured: 4,477 of 15,090 real rows) - deliberately NOT part of the uniqueness key, since a Null value would not conflict with another Null under Postgres unique-constraint semantics.
Format: date
original_vest_date (anyOf 2)nullAlternativeOriginal vest date, as reported by the ingested file. Sparsely populated (measured: 4,477 of 15,090 real rows) - deliberately NOT part of the uniqueness key, since a Null value would not conflict with another Null under Postgres unique-constraint semantics.
Format: date
plan_namestringRequired within parentEquity plan name, as reported by the ingested file.
risk_free_rate_percentJSONRequired within parent
risk_free_rate_percent (anyOf 1)JSONAlternative
risk_free_rate_percent (anyOf 1) (anyOf 1)numberAlternativeRisk-free rate, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows).
Format: double
risk_free_rate_percent (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
risk_free_rate_percent (anyOf 2)nullAlternativeRisk-free rate, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows).
Format: double
risk_free_rate_sourceJSONRequired within parent
risk_free_rate_source (anyOf 1)stringAlternativeRisk-free rate source, as reported by the ingested file. Sparsely populated (measured: 8,308 of 15,090 real rows).
risk_free_rate_source (anyOf 2)nullAlternativeRisk-free rate source, as reported by the ingested file. Sparsely populated (measured: 8,308 of 15,090 real rows).
risk_free_rate_typeJSONRequired within parent
risk_free_rate_type (anyOf 1)stringAlternativeRisk-free rate type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).
risk_free_rate_type (anyOf 2)nullAlternativeRisk-free rate type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).
row_hashstringRequired within parentHash of the reported values on this record. Compare it between syncs to detect a change without diffing every field.
source_file_idstringRequired within parentIdentifier of the ingested Shareworks report file this record was last upserted from.
Format: uuid
updated_atstringRequired within parentTimestamp this record was last upserted, for incremental sync.
Format: date-time
valuation_typestringRequired within parentValuation type, as reported by the ingested file.
volatility_percentJSONRequired within parent
volatility_percent (anyOf 1)JSONAlternative
volatility_percent (anyOf 1) (anyOf 1)numberAlternativeVolatility, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows).
Format: double
volatility_percent (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
volatility_percent (anyOf 2)nullAlternativeVolatility, stored as the percent NUMBER itself, NOT a fraction. See parseShareworksPercent. Sparsely populated (measured: 14,353 of 15,090 real rows).
Format: double
volatility_typeJSONRequired within parent
volatility_type (anyOf 1)stringAlternativeVolatility type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).
volatility_type (anyOf 2)nullAlternativeVolatility type, as reported by the ingested file. Sparsely populated (measured: 14,353 of 15,090 real rows).

SDK function policy ID: deel.equitytokens_listequityvaluations_v2026_09_09. Catalog operation: equitytokens_listequityvaluations_v2026_09_09. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["equities:read"]

Pinned headers: {"X-Version": "2026-09-09"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.