Skip to main content

Overview

Get started with Reality API in minutes.

1.Onboarding​

Contact our team to complete the onboarding process.

2.Setup​

Provide RSA public key IP Whitelists for API authentication, along with a participant address:

  • Instant Trading: authorized address for trading settlement
  • Onchain Swap: permissioned address for minting & redemption

3.Authentication​

Create Secret Key using Access Key provided by Reality:

curl -X POST "https://api.realityfinance.xyz/api/v1/rwa/auth/keys" \
  -H "ACCESS-KEY:***" \
  -H "ACCESS-SIGN:***" \
  -H "ACCESS-TIMESTAMP:1659076670000" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "ACCESS-KEY"  //34_CHARACTER_STRING
}'

Perform RSA signature according to REST API schema with an empty apiSecret field.

4.Integration​

Retrieve assets and market data:

  • Asset API: assets and trading limits (sync hourly recommended for caching)
  • Market API: market data and corporate actions

5.Trading​

Implement the trading mode:

  • Instant Trading: market / limit order execution and settlement
  • Onchain Swap: mint & redemption attestations into workflows

6.Corporate Actions​

Alignment with relevant events:

  • Dividends: claimable dividends via verifiable proofs
  • Splits: automatic balance updates