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 Transaction Analyses API

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

Elliptic Transaction 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 Transaction 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 20 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 20 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 Transaction 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.

Transaction Analyses 5

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

POST
/analyses/synchronous
Run a single analysis
analysisSync body → 200400401403404429500
POST
/analyses
Run a batch of analyses
analysisBatch body → 200207400401403500
GET
/analyses
Paginate all analyses
getAllAnalyses 38 params → 200400401403404500
GET
/analyses/{mc_analysis_id}
Get an analysis by ID
getAnalysisById 3 params → 200400401403404500
GET
/analyses/{mc_analysis_id}/screenings/{screening_id}
Get a screening of the analysis by ID
getAnalysisByScreeningId 2 params → 200400401403404500

Schemas 20

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

WalletAnalysisResponse
object
4 properties
AnalysisSubject
object
8 properties 3 required
BadRequestError
object
2 properties
ForbiddenError
object
2 properties
NotFoundError
object
2 properties
InputOutput
object
An input or output (IO) of a transaction
4 properties
HolisticAnalysisRequest
object
3 properties 3 required
TransactionAnalysisRequestBatch
array
the analyses to request
TransactionAnalysisBatchResponse
array
details of each submitted analysis
UnauthorizedError
string
UTXOBasedAnalysisRequest
object
3 properties 3 required
NotInBlockchain
object
2 properties
Contribution
object
A single contribution entry associated with an entity (holistic — only USD values included)
9 properties 3 required
EvaluationDetailForGetAll
object
details of a single risk rule evaluation for paginated transactions analysis
4 properties 2 required
TransactionAnalysisSingleResponse
object
Response for Transaction Analysis. Represents the full result of a transaction screening, including metadata, risk scores, contributing entities, and evaluatio…
25 properties 16 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
TransactionAnalysisType
string
The type of analysis. The sourceoffunds type is used to get details of the entities that have contributed funds to the transaction's source address, and calcul…
TransactionAnalysisRequestSingle

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elliptic-transaction-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 Workflow API
Elliptic Tron NodeIntelligence API
Elliptic Users API
Elliptic Wallet Analyses API