Skip to main content
POST
Give stock

Authorizations

x-api-key
string
header
required

Your Stockly API key. Identifies your app; you never pass an app id.

Body

application/json
userId
string<uuid>
required

Must reference an existing user in your app.

idempotencyKey
string
required

Unique per logical award. Safe to retry.

Required string length: 8 - 128
amountUsd
number
required

Award value in USD.

Required range: x <= 1000000
assetSymbol
string
required

Stock ticker from the catalog, e.g. AAPL. Normalized to uppercase.

Required string length: 1 - 16
Example:

"AAPL"

source
string

Optional label, e.g. cashback.

Required string length: 1 - 64
metadata
object

Optional arbitrary JSON, returned on reads.

Response

Idempotent replay — the award already existed and is returned unchanged

reward
object

A stock award. Moves from recorded to executed once fulfilled.

status
string
idempotentReplay
boolean