ELelliptic
Wallet Analyses

Paginate all analyses

Paginate through all analyses, with various sort/filter parameters.

get/wallet

Request

  • Base URL
    https://aml-api.elliptic.co/v2
  • URL
    https://aml-api.elliptic.co/v2/wallet
  • Auth
    • HTTP bearer
    • or API key in header x-access-key and API key in header x-access-sign and API key in header x-access-timestamp

Query parameters

min_outflow_usdnumber float

minimum outflow USD value

max_outflow_usdnumber float

maximum outflow USD value

min_inflow_usdnumber float

minimum inflow USD value

max_inflow_usdnumber float

maximum inflow USD value

analysed_at_beforestring date-time

only return wallet analyses that has been analysed before the given time (ISO8601 datetime)

analysed_at_afterstring date-time

only return wallet analyses that has been analysed after the given time (ISO8601 datetime)

customer_reference_containsstring

only return wallet analyses whose customer reference contains the given string

address_hash_containsstring

filter wallet analyses whose address contains the given string

customer_referencestring

only return wallet analyses whose customer reference equals the given string

workflow_statusstring[]

Array of workflow status values for filtering analyses. "archived" is deprecated and you should use "closed" instead.

only return analyses whose workflow status matches any of the given values. Accepts a single value or an array of values.

address_hashstring

filter wallet analyses whose address equals the given string

entity_name_containsstring

filter wallet analyses whose name contains the given string

entity_category_containsstring

filter wallet analyses whose category contains the given string

min_risk_scorenumber float

minimum risk score

max_risk_scorenumber float

maximum risk score

min_risk_score_changenumber float

minimum risk score change since last screening

max_risk_score_changenumber float

maximum risk score change since last screening

coveragestring[]

return the wallet analyses for a certain coverage level

process_statusstring[]

return rows that are in any of the states specified in the array. Each element is one of (running, complete, error).

assetstring[]

return only wallet analyses that has been made on a particular asset or asset/blockchain combination

risk_rulesstring[]

return wallets that has triggered at least one of the specified risk_rules. To get wallet analyses that have not triggered any rules, include empty string in your query. e.g. "?risk_rules=,f7c36274-ba55-4f6b-8d46-d8cbe97d7c32"

analysed_bystring UUIDv4

the ID of the actor who ran the query

customer_idstring UUIDv4

the ID of the customer this wallet analysis is linked to

assigned_team_user_idstring[]

return wallets that are assigned to the given team user ID(s). To get wallet analyses that are unassigned, include an empty string in your query. Multiple IDs can be provided as a comma-separated list.

screening_sourcestring[]

Indicates whether the screening was done via the Synchronous endpoint, Asynchronous endpoint, as part of the Automatic Rescreening feature or as a fallback system rescreening in case of error

sort'entity_name' | '-entity_name' | 'entity_category' | '-entity_category' | 'outflow_usd' | '-outflow_usd' | 'inflow_usd' | '-inflow_usd' | 'asset' | '-asset' | 'customer_reference' | '-customer_reference' | 'analysed_at' | '-analysed_at' | 'risk_score' | '-risk_score' | 'workflow_status' | '-workflow_status'

sort by criterion

pageinteger

pagination page number

per_pagenumber

pagination per page number, has a maximum value of 500.

limitnumber
Example:10000

The maximum number of results that are counted. If more analyses than this number are present then this number is returned. This improves the performance of queries over large datasets

Response

Successful wallet analysis response

pagenumber required
per_pagenumber required
total_pagesnumber required
total_itemsnumber required

Changes

No recorded changes to this operation across all 1 revision of this API.