📨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

Relay Endpoints

Informational

Sending Relay Requests:

Each relay request method possesses optional parameters such as the gasLimit , and retries. You can find more information on these on the Optional Parameters page.

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

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

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

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

Task Tracking

PreviousSyncFee Payment Tokens NextMigration Guide ethers.js v5 to v6

Last updated 1 year ago

#272: W3F context including gelato args

Change request updated 1 year ago

Get list of chains where the oracle is available

get

/oracles

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/oracles'

200

{
  "oracles": [
    "text"
  ]
}

Successful Retrieval

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

get

/oracles/{chainId}/estimate

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

gasLimitL1number

Gas limit for Layer 1

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/oracles/{chainId}/estimate?paymentToken=text&gasLimit=1&isHighPriority=true'

200

404

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

Successful Retrieval

Get all the payment tokens on a chain

get

/oracles/{chainId}/paymentTokens

Path parameters

chainIdnumberrequired

Id of the chain where payments tokens are retrieved

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/oracles/{chainId}/paymentTokens'

200

404

{
  "paymentTokens": [
    "text"
  ]
}

Successful Retrieval

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

get

/oracles/{chainId}/conversionRate

Path parameters

chainIdnumberrequired

Id of the chain where the conversion rate is estimated

Query parameters

tostring

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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/oracles/{chainId}/conversionRate'

200

400

404

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

Successful Conversion Rate Response

Get list of chains where relay v2 is available

get

/relays/v2

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/relays/v2'

200

{
  "relays": [
    "text"
  ]
}

Successful Retrieval

Place a relay v2 callWithSyncFee request

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

post

/relays/v2/call-with-sync-fee

Body

chainIdnumberrequired

targetstringrequired

datastringrequired

feeTokenstringrequired

sponsorApiKeystring

gasLimitstring

retriesnumber

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/relays/v2/call-with-sync-fee' \
  --header 'Content-Type: application/json' \
  --data '{"chainId":1,"target":"text","data":"text","feeToken":"text"}'

201

400

404

{
  "taskId": "text"
}

Successfully placed a callWithSyncFee request

Place a relay v2 callWithSyncFeeERC2771 request

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

post

/relays/v2/call-with-sync-fee-erc2771

Body

chainIdnumberrequired

targetstringrequired

datastringrequired

userstringrequired

userNoncenumberrequired

userDeadlinenumberrequired

userSignaturestringrequired

feeTokenstringrequired

isRelayContextboolean

sponsorApiKeystring

gasLimitstring

retriesnumber

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/relays/v2/call-with-sync-fee-erc2771' \
  --header 'Content-Type: application/json' \
  --data '{"chainId":1,"target":"text","data":"text","user":"text","userNonce":1,"userDeadline":1,"userSignature":"text","feeToken":"text"}'

201

400

404

{
  "taskId": "text"
}

Successfully placed a callWithSyncFeeERC2771 request

Place a relay v2 sponsoredCall request

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

post

/relays/v2/sponsored-call

Body

chainIdnumberrequired

targetstringrequired

datastringrequired

sponsorApiKeystringrequired

gasLimitstring

retriesnumber

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/relays/v2/sponsored-call' \
  --header 'Content-Type: application/json' \
  --data '{"chainId":1,"target":"text","data":"text","sponsorApiKey":"text"}'

201

400

404

{
  "taskId": "text"
}

Successfully placed a sponsoredCall relay request

Place a relay v2 sponsoredCallERC2771 request

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

post

/relays/v2/sponsored-call-erc2771

Body

chainIdnumberrequired

targetstringrequired

datastringrequired

userstringrequired

userNoncenumberrequired

userDeadlinenumberrequired

userSignaturestringrequired

sponsorApiKeystringrequired

gasLimitstring

retriesnumber

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/relays/v2/sponsored-call-erc2771' \
  --header 'Content-Type: application/json' \
  --data '{"chainId":1,"target":"text","data":"text","user":"text","userNonce":1,"userDeadline":1,"userSignature":"text","sponsorApiKey":"text"}'

201

400

404

{
  "taskId": "text"
}

Successfully placed a sponsoredCallERC2771 relay request

Get task status of the relay v2 task id

get

/tasks/status/{taskId}

Path parameters

taskIdstringrequired

Id of the task whose status is retrieved

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/tasks/status/{taskId}'

200

404

500

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

Successful Retrieval