@aptos-labs/ts-sdk - v3.1.1
    Preparing search index...

    Type Alias GetRequestOptions

    Options for making a GET request, including configuration for the API client.

    type GetRequestOptions = {
        acceptType?: MimeType;
        aptosConfig: AptosConfig;
        contentType?: MimeType;
        originMethod: string;
        overrides?: ClientConfig;
        params?: Record<string, string | AnyNumber | boolean | undefined>;
        path: string;
        type: AptosApiType;
    }
    Index

    Implementation - Client

    acceptType? aptosConfig contentType? originMethod overrides? params? path type

    Implementation - Client

    acceptType?: MimeType

    The accepted content type of the response of the API

    aptosConfig: AptosConfig

    The config for the API client

    contentType?: MimeType

    The content type of the request body

    originMethod: string

    The name of the API method

    overrides?: ClientConfig

    Specific client overrides for this request to override aptosConfig

    params?: Record<string, string | AnyNumber | boolean | undefined>

    The query parameters for the request

    path: string

    The URL path to the API method

    type: AptosApiType

    The type of API endpoint to call e.g. fullnode, indexer, etc

    Settings

    Member Visibility

    On This Page

    Implementation - Client