Interface BrandfetchV2NodeParameters

Source

interface BrandfetchV2NodeParameters {
    cachedOnly?: boolean;
    domain?: string;
    download?: boolean;
    identifier?: string;
    operation?: "logo" | "colors" | "data" | "context";
    outputFormat?: "json" | "markdown";
    type?: "domain" | "ticker" | "crypto" | "isin";
}

Properties§

§readonly cachedOnly?: boolean

Whether to return the brand context only if one is already cached, responding instantly without crawling the domain. Returns an empty item if no cached context exists.

§readonly domain?: string

The domain name of the brand to get context for

§readonly download?: boolean

Whether to download all logo files as binary data

§readonly identifier?: string

The identifier of the brand. Format depends on the selected Type (e.g. apple.com, AAPL, BTC, US0378331005).

§readonly operation?: "logo" | "colors" | "data" | "context"

Default: "data"

§readonly outputFormat?: "json" | "markdown"

The format the brand context is returned in Default: "json"

§readonly type?: "domain" | "ticker" | "crypto" | "isin"

The type of identifier used to look up the brand Default: "domain"