Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elliptic Wallet Analyses API

Run blockchain analysis against one or more wallets. Get and update previously run analyses.

Elliptic Wallet Analyses API is one of 16 APIs that Elliptic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Wallet Analyses. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and rate-limit docs.

This API exposes 5 operations across 4 paths, and defines 18 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://aml-api.elliptic.co/v2.

5 operations 4 paths 18 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://aml-api.elliptic.co
Authentication
OAuth 2.0, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 4

Elliptic Wallet Analyses API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 2 scopes. An API key is passed in the header as x-access-key (apiKey). An API key is passed in the header as x-access-sign (signature). An API key is passed in the header as x-access-timestamp (timestamp). By default, every request must be authenticated.

  • apiKey — API Key
  • signature — (Request Time, HTTP Method, Lowercase Path, Request Payload) signed with API Secret

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Wallet Analyses 5

Run blockchain analysis against one or more wallets. Get and update previously run analyses.

POST
/wallet/synchronous
Run a single analysis
body → 200400401403404429500
POST
/wallet
Run a batch of analyses.
body → 200207400401403500
GET
/wallet
Paginate all analyses
29 params → 200400401403404500
GET
/wallet/{wallet_analysis_id}
Get an analysis by ID
3 params → 200400401403404500
GET
/wallet/{wallet_analysis_id}/screenings/{screening_id}
Get a screening of the wallet by ID
2 params → 200400401403404500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are WalletAnalysisResponse (27 properties), MatchedElement (9 properties), Contribution (9 properties), WalletAssertedLabel (8 properties). Each schema is shown below with its type and property counts.

HolisticWalletAnalysisRequest
object
3 properties 2 required
WalletAnalysisResponse
object
Response for Wallet Analysis. Represents the full result of a holistic wallet analysis, including metadata, risk scores, and contributing entities.
27 properties 12 required
AnalysisSubject
object
8 properties 3 required
BadRequestError
object
2 properties
ForbiddenError
object
2 properties
NotFoundError
object
2 properties
UTXOBasedWalletAnalysisRequest
object
3 properties 2 required
WalletAssertedLabel
object
An Elliptic-created, wallet asserted label to be attached to a cluster
8 properties 3 required
UnauthorizedError
string
WalletAnalysisType
string
The type of analysis. Currently it is walletexposure
WalletRequestBatch
array
the analyses to request
NotInBlockchain
object
2 properties
Contribution
object
A single contribution entry associated with an entity (holistic — only USD values included)
9 properties 3 required
WalletAnalysisSubject
object
Information describing the subject of the analysis
4 properties 3 required
MatchedElement
object
Entity or group of entities identified as contributing to the risk rule. Note: In holistic responses, values are expressed in USD only.
9 properties 4 required
EvaluationDetail
object
Details of a single risk rule evaluation. Note: if matchedbehaviors is present, matchedelements will be empty, and vice versa— rules cannot match both entities…
8 properties 2 required
Error
object
2 properties
WalletRequestSingle

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elliptic-wallet-analyses-api-openapi.yml Raw ↑

Other APIs Elliptic publishes across the network.

Elliptic Assets API
Elliptic Count Analyses API
Elliptic Criteria API
Elliptic Customers API
Elliptic Health API
Elliptic Risk Rules API
Elliptic Sanctions API
Elliptic Screenings API
Elliptic Transaction Analyses API
Elliptic Transaction Workflow API
Elliptic Tron NodeIntelligence API
Elliptic Users API