Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.relay.link/llms.txt

Use this file to discover all available pages before exploring further.

​
Parameters

ParameterDescriptionRequired
baseApiUrlBase api url for the relay api, defaults to https://api.relay.link but can also be configured to https://api.testnets.relay.link❌
optionsQuery parameters that map directly to the requests api❌
queryOptionsTanstack query options. Refer to the Tanstack docs.❌

​
Return Data

The hook returns an object with the base Tanstack Query response. The data property maps to the object returned in the aforementioned requests api.

​
Usage

import { useRequests } from '@relayprotocol/relay-kit-hooks'

const { data: transactions } = useRequests()

​
Query Function

import { queryRequests } from '@relayprotocol/relay-kit-hooks'

queryRequests()