Fetch Wallet Screening

Quadrata SDK API Service: Fetch Wallet Screening

Fetch the on-chain wallet screening score for a wallet address. This is an attribute query and incurs Quad Unit charges. This feature must be enabled for your dApp.

Parameters

Name	Type	Description
apiKey*	string	Your API Key
walletAddress*	hex string	Wallet address
privateKeyDerBase64	string	Base64 DER String
privateKeyDer	string	DER Binary String
privateKeyPem	string	PEM String
privateKey	CryptoKey	CryptoKey object
options	object	Fetch Options

One private key parameter is required. You can provide your private key in any of the formats listed.

See API Service Options for more information

SDK Configuration

Name	Type	Description
environment*	QuadrataEnvironment	Access token See createAccessToken

See API Get On-Chain AML Score for more information about the underlying API endpoint.

Example

import type { API } from '@quadrata/sdk/types';
import { fetchWalletScreening, QuadrataEnvironment } from '@quadrata/sdk/api';

type ResponseType = API.Service.FetchWalletScreening.Response;
type ParsedResponseType = API.Service.FetchWalletScreening.ParsedResponse;

const response: ResponseType = await fetchWalletScreening(
    // params
    {
        apiKey: process.env.QUADRATA_API_KEY,
        walletAddress: '0x123',
        
        // private signign key
        privateKeyDerBase64: process.env.QUADRATA_PRIVATE_KEY_DER_BASE64,
        
        // optional fetch options
        options: {
            cache: 'no-cache'
        }
    },
    // sdk config
    { environment: QuadrataEnvironment.PRODUCTION }
);

const screeningData: ParsedResponseType = response.data;
// screeningData.address
// screeningData.score
// screeningData.verifiedAt