Skip to content

by Startups.Studio

Finance Instrument

Instrument.get

GET /{namespace}/instruments/{id}

Returns one Instrument by id.

Noun: Instrument
Mode: read

You, to your agent

Show me the latest instrument.

curl https://api.sb/shiftnote.app/instruments/instrument_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const instrument = await $.Instrument.get({ id: 'instrument_1' })

npx startup-builder do Instrument.get --json '{"id":"instrument_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Instrument.get({ id: 'instrument_1' })"
  }
}

Get returns one Instrument by id. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Instrument.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Outputs

Output	Type	Required	Description
`instrument`	Instrument	required	The Instrument.

Effects

Reads only: it emits no Event and changes nothing.
Read: try, do.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Instrument.get

When it waits

Never: a read runs at once.

Instrument.exercise

Previous Page

Instrument.grant

Next Page