Skip to content

Mercury: Get all SAF Es

Mercury safes.getSafeRequests: arguments, response, policy and SDK examples.

← Safes operations · Get started

Operation mercury.getsaferequests

Provider route: GET /safes. Alter supplies the connection’s credentials and routing.

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

import { App } from "@alter-ai/sdk";
import { MercuryIntegration } from "@alter-ai/mercury";
async function execute(input: Parameters<MercuryIntegration["safes"]["getSafeRequests"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new MercuryIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.safes.getSafeRequests(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_mercury import MercuryIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = MercuryIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.safes.get_safe_requests(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed

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

FieldTypePresenceDescription and constraints
$arrayRoot
$[]ModelEach itemExpand Get SAFE by ID — response body

Referenced models: Get SAFE by ID — response body

Get SAFE by ID — response body
FieldTypePresenceDescription and constraints
$objectRootA summary of a SAFE request.
canceledAtJSONOptional
canceledAt (anyOf 1)JSONAlternative
canceledAt (anyOf 1) (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
canceledAt (anyOf 2)nullAlternative
discountRateJSONOptional
discountRate (anyOf 1)JSONAlternative
discountRate (anyOf 1) (anyOf 1)numberAlternativeMultiple of: 0.01
discountRate (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
discountRate (anyOf 2)nullAlternative
documentUrlstringRequired within parent
expiresAtJSONRequired within parent
expiresAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
governingStateJSONOptional
governingState (anyOf 1)JSONAlternative
governingState (anyOf 1) (allOf 1)stringAll variants applyKnown values: AL, AK, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY
governingState (anyOf 2)nullAlternative
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the SAFE request
Format: uuid
includesMostFavoredNationClausebooleanRequired within parent
includesProRataRightsLetterbooleanRequired within parent
investmentAmountJSONRequired within parent
investmentAmount (allOf 1)ModelAll variants applyExpand Request to send money — response body — amount value
investmentDateJSONRequired within parent
investmentDate (allOf 1)stringAll variants applyFormat: date
investorJSONRequired within parent
investor (allOf 1)ModelAll variants applyExpand Get SAFE by ID — response body — investor Details about the investor buying the equity
organizationJSONRequired within parent
organization (allOf 1)ModelAll variants applyExpand Get SAFE by ID — response body — organization Details about the organization selling the equity
paidAtJSONOptional
paidAt (anyOf 1)JSONAlternative
paidAt (anyOf 1) (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
paidAt (anyOf 2)nullAlternative
signedByInvestorAtJSONOptional
signedByInvestorAt (anyOf 1)JSONAlternative
signedByInvestorAt (anyOf 1) (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
signedByInvestorAt (anyOf 2)nullAlternative
signedByOwnerAtJSONOptional
signedByOwnerAt (anyOf 1)JSONAlternative
signedByOwnerAt (anyOf 1) (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
signedByOwnerAt (anyOf 2)nullAlternative
valuationCapJSONOptional
valuationCap (anyOf 1)JSONAlternative
valuationCap (anyOf 1) (allOf 1)ModelAll variants applyExpand Request to send money — response body — amount value
valuationCap (anyOf 2)nullAlternative
valuationTypeJSONRequired within parent
valuationType (allOf 1)stringAll variants applyKnown values: PreMoney, PostMoney, NoValuation

Referenced models: Get SAFE by ID — response body — investor Details about the investor buying the equity, Get SAFE by ID — response body — organization Details about the organization selling the equity, Request to send money — response body — amount value

Get SAFE by ID — response body — investor Details about the investor buying the equity
FieldTypePresenceDescription and constraints
$objectRootDetails about the investor buying the equity.
additionalBylinesJSONOptional
additionalBylines (anyOf 1)stringAlternativeMaximum length: 299
Minimum length: 1
additionalBylines (anyOf 2)nullAlternative
addressJSONOptional
address (anyOf 1)stringAlternativeMaximum length: 299
Minimum length: 1
address (anyOf 2)nullAlternative
investorTypeJSONRequired within parent
investorType (allOf 1)stringAll variants applyKnown values: SafeRequestInvestorTypeIndividual, SafeRequestInvestorTypeVentureFund, SafeRequestInvestorTypeOther
legalEntityNamestringRequired within parentMaximum length: 299
Minimum length: 1
signatoryEmailJSONRequired within parent
signatoryEmail (allOf 1)stringAll variants apply
signatoryNamestringRequired within parentMaximum length: 5000
Minimum length: 1
signatoryTitleJSONOptional
signatoryTitle (anyOf 1)stringAlternativeMaximum length: 299
Minimum length: 1
signatoryTitle (anyOf 2)nullAlternative
Get SAFE by ID — response body — organization Details about the organization selling the equity
FieldTypePresenceDescription and constraints
$objectRootDetails about the organization selling the equity
legalEntityNamestringRequired within parentMaximum length: 299
Minimum length: 1
signatoryEmailJSONRequired within parent
signatoryEmail (allOf 1)stringAll variants apply
signatoryNamestringRequired within parentMaximum length: 5000
Minimum length: 1
signatoryTitlestringRequired within parentMaximum length: 299
Minimum length: 1
Request to send money — response body — amount value
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)numberAlternativeA positive dollar amount with at least 1 cent.
Format: double
Minimum: 0.01
$ (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

SDK function policy ID: mercury.getsaferequests. Catalog operation: mercury:getSafeRequests. 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.

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.