Transaction Analyses

Paginate all analyses

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

get/analyses

Request

  • Base URL
    https://aml-api.elliptic.co/v2
  • URL
    https://aml-api.elliptic.co/v2/analyses
  • 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

expandstring[]

comma-separated list of child nested objects to expand in the response, e.g. ?expand=contributions

tx_time_beforestring date-time

filter out all customer transactions whose tx_time is <= the provided value (ISO8601 datetime)

tx_time_afterstring date-time

filter out all customer transactions whose tx_time is >= the provided value (ISO8601 datetime)

has_triggered_ruleboolean

filter by transactions based on whether they've triggered any rules

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

min_valueinteger

minimum value of the asset in it's minor unit (satoshis, wei etc)

max_valueinteger

minimum value of the asset in it's minor unit (satoshis, wei etc)

min_value_usdnumber float

minimum USD value

max_value_usdnumber float

maximum USD value

analysed_at_beforestring date-time

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

analysed_at_afterstring date-time

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

customer_referencestring

only return analysis whose customer reference matches the given string

customer_reference_containsstring

only return analysis whose customer reference contains the given string

workflow_statusSchema (unresolved $ref)

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

hashstring

filter customer transactions whose hash is equal to the given one (case insensitive)

hash_containsstring

filter customer transactions whose hash contains the given string (case insensitive)

address_hashstring

filter customer transactions whose address is equal to the given one (case insensitive)

address_hash_containsstring

filter customer transactions whose address contains the given string (case insensitive)

idstring[]

get only transactions with given ids

coveragestring[]

return the transaction analyses for a certain coverage level

analysed_bystring UUIDv4

the ID of the actor who ran the query

customer_idstring UUIDv4

the ID of the customer this transaction is linked to

assigned_team_user_idstring[]

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

process_statusstring[]

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

risk_rulesstring[]

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

type'deposit' | 'withdrawal'

get only deposit or withdrawal analyses

user_supplied_base58boolean

if true, returns only transactions created by users that have provided a base58 (for BTC only). Otherwise, return those with provided output_indices.

assetstring[]

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

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'created_at' | '-created_at' | 'customer_reference' | '-customer_reference' | 'type' | '-type' | 'tx_hash' | '-tx_hash' | 'address_hash' | '-address_hash' | 'analysed_at' | '-analysed_at' | 'tx_time' | '-tx_time' | 'risk_score' | '-risk_score' | 'value' | '-value' | 'value_usd' | '-value_usd' | 'user_supplied_base58' | '-user_supplied_base58' | 'asset' | '-asset' | 'workflow_status' | '-workflow_status' | 'predictive' | '-predictive'

Sort by criterion

pageinteger

pagination page number

per_pagenumber

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

subject_type'transaction' | 'address'

get only transaction or address analyses

predictiveboolean

get only Predictive transactions. Predictive transactions were analyzed too close to the tip of the blockchain, so the full picture of associated addresses might be incomplete.

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 transaction 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.