QueryParams: {
    fxRateFor?: SupportedFiatType;
    image?: {
        medium?: ImageTransform;
        small?: ImageTransform;
    };
    profile?: {
        cover?: ImageTransform;
        metadataSource?: AppId;
        thumbnail?: ImageTransform;
    };
    statsFor?: AppId[];
}

The common query parameters used across any query.

Type declaration

  • Optional fxRateFor?: SupportedFiatType

    The fiat currency to use for the fx rate

    Default Value

    USD
    
  • Optional image?: {
        medium?: ImageTransform;
        small?: ImageTransform;
    }

    The size of the publication image.

    Default Value

    see individual fields
    
    • Optional medium?: ImageTransform

      The size of the medium publication image

      Default Value

      width: 700px, height: auto, keepAspectRatio: true
      
    • Optional small?: ImageTransform

      The size of the small publication image

      Default Value

      width: 400px, height: auto, keepAspectRatio: true
      
  • Optional profile?: {
        cover?: ImageTransform;
        metadataSource?: AppId;
        thumbnail?: ImageTransform;
    }

    Profile related fields parameters

    Default Value

    see individual fields
    
    • Optional cover?: ImageTransform

      The size of the cover image

      Default Value

      width: 1100px, height: auto, keepAspectRatio: true
      
    • Optional metadataSource?: AppId

      The source to use for fetching profile metadata details.

      If not provided, it will default to the global profile metadata for any profile fetched.

      If provided and a profile does not have bespoke profile metadata it will fallback to their global profile metadata.

      To know more about app specific profile metadata, see example with appId in https://lens-protocol.github.io/metadata/functions/profile.html.

      Default Value

      empty, global profile metadata
      
    • Optional thumbnail?: ImageTransform

      The size of optimized profile image

      Default Value

      width: 256px, height: auto, keepAspectRatio: true
      
  • Optional statsFor?: AppId[]

    The App Ids for which to fetch Publication and Profile Stats for.

    Affects mainly comments, mirrors, and quotes counts.

    Default Value

    empty, all apps