Gas station

List sub-domains in a domain with their sponsorship status

Returns all sub-domains within the domain along with whether each sub-domain is currently sponsored by a Gas Station.

get/v1/domains/{domainId}/sponsors/sponsored-domains

Request

Base URL
https://docs.ripple.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ripple/apis/ripple-custody-api/docs/v1/domains/:domainId/sponsors/sponsored-domains/get.ts
A function with typed inputs. Its response is checked against the schema.

domainIdstring uuid required

Domain ID to list sponsored sub-domains for

limitnumber

Maximum number of items per page

startingAfterstring

Cursor for pagination - returns items after this ID

sortBystring

Field to sort by

sortOrder'asc' | 'desc'

Sort direction

sponsorAccountIdstring uuid

Filter by a specific sponsor account ID. When provided, only entities sponsored by this sponsor are marked as sponsored.

List of sub-domains with sponsorship status

countnumber required

Total count of items in current page

currentStartingAfterstring

Current pagination cursor

nextStartingAfterstring

Next pagination cursor for fetching more items

No recorded changes to this operation across all 3 revisions of this API.