Relay API

How to communicate directly with the Gelato Relay API

The Gelato Relay API endpoint URL is https://api.gelato.digital/

The Swagger UI is located at https://api.gelato.digital/api-docs

Oracle queries

Get list of chains where the oracle is available

get

Responses

200

Successful Retrieval

application/json

get

HTTPcURLJavaScriptPython

GET /oracles HTTP/1.1
Host: 
Accept: */*

200

Successful Retrieval

{
  "oracles": [
    "text"
  ]
}

Get the estimated fee in payment token with respect to the gas limit and priority

get

Path parameters

chainIdnumberRequired

Id of the chain where the fee is estimated

Query parameters

paymentTokenstringRequired

Payment Token

gasLimitnumberRequired

Gas limit

isHighPrioritybooleanRequired

Priority | if high: true, otherwise: false

gasLimitL1numberOptional

Gas limit for Layer 1 | For OP stack chains input BigInt(0)

Responses

200

Successful Retrieval

application/json

404

Oracle Not Found

get

HTTPcURLJavaScriptPython

GET /oracles/{chainId}/estimate?paymentToken=text&gasLimit=1&isHighPriority=true HTTP/1.1
Host: 
Accept: */*

{
  "estimatedFee": "text",
  "decimals": 1
}

Get all the payment tokens on a chain

get

Path parameters

chainIdnumberRequired

Id of the chain where payments tokens are retrieved

Responses

200

Successful Retrieval

application/json

404

Oracle Not Found

get

HTTPcURLJavaScriptPython

GET /oracles/{chainId}/paymentTokens HTTP/1.1
Host: 
Accept: */*

{
  "paymentTokens": [
    "text"
  ]
}

Get the conversion rate from the native token to the requested token

get

Path parameters

chainIdnumberRequired

Id of the chain where the conversion rate is estimated

Query parameters

tostringOptional

Token in which the conversion rate is estimated from the native token of the selected chain. If a value is not provided, it will default to the USDC address on the selected chain

Responses

200

Successful Conversion Rate Response

application/json

400

Bad Request

404

Oracle Not Found

get

HTTPcURLJavaScriptPython

GET /oracles/{chainId}/conversionRate HTTP/1.1
Host: 
Accept: */*

{
  "chainId": "text",
  "from": "text",
  "to": "text",
  "conversionRate": 1,
  "details": {
    "numerator": "text",
    "denominator": "text"
  }
}

Relay Endpoints

Informational

Get list of chains where relay v2 is available

get

Responses

200

Successful Retrieval

application/json

get

HTTPcURLJavaScriptPython

GET /relays/v2 HTTP/1.1
Host: 
Accept: */*

200

Successful Retrieval

{
  "relays": [
    "text"
  ]
}

Sending Relay Requests:

Each relay request method possesses optional parameters such as the gasLimit , and retries.

/call-with-sync-fee/: for more information, please click here.

Place a relay v2 callWithSyncFee request

post

Please find more information here: https://docs.gelato.network/developer-products/gelato-relay-sdk/sdk-methods/relaywithsyncfee

Body

chainIdnumberRequired

targetstringRequired

datastringRequired

feeTokenstringRequired

sponsorApiKeystringOptional

gasLimitstringOptional

retriesnumberOptional

Responses

201

Successfully placed a callWithSyncFee request

application/json

400

Validation Error

404

Service Not Found

post

HTTPcURLJavaScriptPython

POST /relays/v2/call-with-sync-fee HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "chainId": 1,
  "target": "text",
  "data": "text",
  "feeToken": "text",
  "sponsorApiKey": "text",
  "gasLimit": "text",
  "retries": 1
}

{
  "taskId": "text"
}

/call-with-sync-fee-erc2771/: for more information, please click here.

Place a relay v2 callWithSyncFeeERC2771 request

post

Please find more information here: https://docs.gelato.network/developer-products/gelato-relay-sdk/sdk-methods/relaywithsyncfeeERC2771

Body

chainIdnumberRequired

targetstringRequired

datastringRequired

userstringRequired

userNoncenumberRequired

userDeadlinenumberRequired

userSignaturestringRequired

feeTokenstringRequired

isRelayContextbooleanOptional

sponsorApiKeystringOptional

gasLimitstringOptional

retriesnumberOptional

Responses

201

Successfully placed a callWithSyncFeeERC2771 request

application/json

400

Validation Error

404

Service Not Found

post

HTTPcURLJavaScriptPython

POST /relays/v2/call-with-sync-fee-erc2771 HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 204

{
  "chainId": 1,
  "target": "text",
  "data": "text",
  "user": "text",
  "userNonce": 1,
  "userDeadline": 1,
  "userSignature": "text",
  "feeToken": "text",
  "isRelayContext": true,
  "sponsorApiKey": "text",
  "gasLimit": "text",
  "retries": 1
}

{
  "taskId": "text"
}

/sponsored-call/: for more information, please click here.

Place a relay v2 sponsoredCall request

post

Please find more information here: https://docs.gelato.network/developer-products/gelato-relay-sdk/sdk-methods/relaywithsponsoredcall

Body

chainIdnumberRequired

targetstringRequired

datastringRequired

sponsorApiKeystringRequired

gasLimitstringOptional

retriesnumberOptional

Responses

201

Successfully placed a sponsoredCall relay request

application/json

400

Validation Error

404

Service Not Found

post

HTTPcURLJavaScriptPython

POST /relays/v2/sponsored-call HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "chainId": 1,
  "target": "text",
  "data": "text",
  "sponsorApiKey": "text",
  "gasLimit": "text",
  "retries": 1
}

{
  "taskId": "text"
}

/sponsored-call-erc2771/: for more information, please click here.

Place a relay v2 sponsoredCallERC2771 request

post

Please find more information here: https://docs.gelato.network/developer-products/gelato-relay-sdk/sdk-methods/relaywithsponsoreduserauthcall

Body

chainIdnumberRequired

targetstringRequired

datastringRequired

userstringRequired

userNoncenumberRequired

userDeadlinenumberRequired

userSignaturestringRequired

sponsorApiKeystringRequired

gasLimitstringOptional

retriesnumberOptional

Responses

201

Successfully placed a sponsoredCallERC2771 relay request

application/json

400

Validation Error

404

Service Not Found

post

HTTPcURLJavaScriptPython

POST /relays/v2/sponsored-call-erc2771 HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "chainId": 1,
  "target": "text",
  "data": "text",
  "user": "text",
  "userNonce": 1,
  "userDeadline": 1,
  "userSignature": "text",
  "sponsorApiKey": "text",
  "gasLimit": "text",
  "retries": 1
}

{
  "taskId": "text"
}

Task Tracking

Get task status of the relay v2 task id

get

Path parameters

taskIdstringRequired

Id of the task whose status is retrieved

Responses

200

Successful Retrieval

application/json

404

Status Not Found

500

Service Not Available

get

HTTPcURLJavaScriptPython

GET /tasks/status/{taskId} HTTP/1.1
Host: 
Accept: */*

{
  "task": {
    "chainId": 1,
    "taskId": "text",
    "taskState": "CheckPending",
    "creationDate": "text",
    "lastCheckDate": "text",
    "lastCheckMessage": "text",
    "transactionHash": "text",
    "executionDate": "text",
    "blockNumber": 1
  }
}

Debug Endpoint

Retrieve debug information for a specific task

get

Path parameters

taskIdstringRequired

The ID of the task to retrieve debug information for.

Query parameters

tenderlyUsernamestringRequired

Username for Tenderly account.

tenderlyProjectNamestringRequired

Project name on Tenderly.

Responses

200

Successful response with debug information.

application/json

400

Bad request if the task ID or parameters are missing or incorrect.

404

Not found if the task ID does not exist.

get

HTTPcURLJavaScriptPython

GET /tasks/status/{taskId}/debug HTTP/1.1
Host: api.gelato.digital
Accept: */*

{
  "data": {
    "to": "text",
    "from": "text",
    "calldata": "text",
    "blockNumber": 1,
    "gasLimit": 1,
    "chainId": 1,
    "taskId": "text"
  },
  "debugger": {
    "tenderly": "text"
  }
}

How to use it with Tenderly

If you'd like to use the debug endpoint with tenderly, you can make use of the debug endpoint and by adding the following parameters

• tenderlyUsername

• tenderlyProjectName

the request URL should look like this: https://api.gelato.digital/tasks/status/{yourRelayTaskId}/debug?tenderlyUsername={yourUserName}&tenderlyProjectName={yourProjectName}

Everything will already be pre-set, all you need to do is click on "Simulate" and check what might have been the point of failure:

What to do if the calldata is too big?

If the calldata is too big which may result in the following error upon clicking on the url returned by the api response:

In this case you would have to manually copy and paste the to, from, callData, blockNumber etc into the Tenderly UI or Foundry