Skip to content

GET /v1/sandbox

Availability
Private Preview
Method and path
GET /v1/sandbox
API version
1.0.0-private-preview
Base URL
https://api.torq.finance
Authentication
SecretKey
Idempotency
Not declared by this operation.
Rate limits
Read x-ratelimit-* and x-request-id response headers. Do not hard-code a quota.

Authentication requirements

  • SecretKey

Request examples

terminal
curl -X GET 'https://api.torq.finance/v1/sandbox' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer $TORQ_SECRET_KEY'
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
None.

Responses

200
Successful response
SandboxState
400
Invalid request
TorqApiError
401
Authentication required
TorqApiError
403
Insufficient scope or authority
TorqApiError
404
Sandbox has not been provisioned for this application
TorqApiError
409
State or idempotency conflict
TorqApiError
429
Rate limit exceeded
TorqApiError
500
Internal failure
TorqApiError

200 response schema

SandboxState SandboxState

id
string
Yes
—
applicationId
string
Yes
—
network
NetworkConfig
Yes
—
deploymentNamespace
string
Yes
—
fixtureSet
string
Yes
—
status
string
Yes
—
resourceQuota
object
Yes
—
faucetQuota
object
Yes
—
seededAt
string | null (date-time)
Yes
—
lastResetAt
string | null (date-time)
Yes
—
Inspect nested properties

id string · required

minimum length: 1 · maximum length: 200

applicationId string · required

minimum length: 1 · maximum length: 200

network NetworkConfig · required

chainId
integer
Yes
—
network
string
Yes
—
deploymentNamespace
string
Yes
—
explorerUrl
string | null (uri)
No
—
Inspect nested properties

chainId integer · required

minimum: 1

network string · required

deploymentNamespace string · required

explorerUrl string | null (uri) · optional

nullable

deploymentNamespace string · required

minimum length: 1 · maximum length: 200

fixtureSet string · required

minimum length: 1 · maximum length: 200

status string · required

minimum length: 1 · maximum length: 100

resourceQuota object · required

faucetQuota object · required

seededAt string | null (date-time) · required

nullable

lastResetAt string | null (date-time) · required

nullable

400, 401, 403, 404, 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.