Skip to content

POST /v1/sandbox/faucet-claims

Availability
Private Preview
Method and path
POST /v1/sandbox/faucet-claims
API version
1.0.0-private-preview
Base URL
https://api.torq.finance
Authentication
SecretKey, WalletSession, PublishableKey
Idempotency
Required header: Idempotency-Key.
Rate limits
Read x-ratelimit-* and x-request-id response headers. Do not hard-code a quota.

Authentication requirements

  • SecretKey
  • WalletSession
  • PublishableKey

Request examples

terminal
curl -X POST 'https://api.torq.finance/v1/sandbox/faucet-claims' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer $TORQ_SECRET_KEY' \
  -H 'x-torq-wallet-session: $TORQ_WALLET_SESSION' \
  -H 'Idempotency-Key: $TORQ_IDEMPOTENCY_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"walletAddress":"0x4ac10f0186719528ae77B1cf6186AE83002C450D","assetAddress":"0x4ac10f0186719528ae77B1cf6186AE83002C450D","amount":"sample_amount"}'
Run a safe sample

This calls the docs preview and returns sample data shaped by the governed OpenAPI response. It never accepts credentials or changes protocol state.

Run the sample call to inspect a schema-shaped response without credentials or side effects.
Request body
SandboxFaucetClaimRequest

Parameters

Idempotency-Key
header
Yes
string

Request schema

SandboxFaucetClaimRequest SandboxFaucetClaimRequest

walletAddress
string
Yes
—
assetAddress
string
Yes
—
amount
string
Yes
—
Inspect nested properties

walletAddress string · required

pattern: ^0x[a-fA-F0-9]{40}$

assetAddress string · required

pattern: ^0x[a-fA-F0-9]{40}$

amount string · required

pattern: ^[1-9][0-9]{0,38}$

Responses

200
Successful response
SandboxFaucetClaim
400
Invalid request
TorqApiError
401
Authentication required
TorqApiError
403
Insufficient scope or authority
TorqApiError
409
State or idempotency conflict
TorqApiError
429
Rate limit exceeded
TorqApiError
500
Internal failure
TorqApiError

200 response schema

SandboxFaucetClaim SandboxFaucetClaim

id
string
Yes
—
sandboxId
string
Yes
—
walletAddress
string
Yes
—
assetAddress
string
Yes
—
amount
string
Yes
—
claimId
string
Yes
—
status
enum
Yes
—
requestedAt
string (date-time)
Yes
—
Inspect nested properties

id string · required

minimum length: 1 · maximum length: 200

sandboxId string · required

minimum length: 1 · maximum length: 200

walletAddress string · required

pattern: ^0x[a-fA-F0-9]{40}$

assetAddress string · required

pattern: ^0x[a-fA-F0-9]{40}$

amount string · required

pattern: ^[1-9][0-9]{0,38}$

claimId string · required

pattern: ^0x[a-fA-F0-9]{64}$

status enum · required

one of: requested, submitted, mined, indexed, persisted_visible, final_success, failed

requestedAt string (date-time) · required

400, 401, 403, 409, 429, 500 response schema

TorqApiError TorqApiError

ok
boolean
Yes
—
code
string
Yes
—
message
string
Yes
—
requestId
string
Yes
—
retryable
boolean
Yes
—
blockedReason
string | null
No
—
docsUrl
string (uri)
No
—
Inspect nested properties

ok boolean · required

code string · required

minimum length: 1 · maximum length: 200

message string · required

minimum length: 1 · maximum length: 200

requestId string · required

minimum length: 1 · maximum length: 200

retryable boolean · required

blockedReason string | null · optional

nullable

docsUrl string (uri) · optional

Related guides

For retry behavior and blocked-state handling, see Errors and rate limits.