Skip to main content

​
Get Sample Matches

GET /matches/sample/{sample_id}
Returns all matches for a specific sample against the entire database.
​
sample_id
integer
required
ID of the sample to match
​
minhash_threshold
float
Minimum MinHash similarity threshold (0.0 to 1.0)
​
pichash_size
integer
PicHash size threshold
​
band_matches_required
integer
Minimum number of band matches required
​
status
string
Response status
​
data
object
Match results including:
  • Matched samples with similarity scores
  • Function-level matches
  • Aggregated statistics
{
  "status": "successful",
  "data": {
    "sample_matches": {
      "2": {
        "sample_id": 2,
        "family": "emotet",
        "matched_functions": 42,
        "score": 0.85
      }
    }
  }
}

​
Cross Match Samples

GET /matches/sample/cross/{sample_ids}
Performs pairwise matching between multiple samples.
​
sample_ids
string
required
Comma-separated list of sample IDs (e.g., “1,2,3”)
​
minhash_threshold
float
Minimum MinHash similarity threshold
​
pichash_size
integer
PicHash size threshold
​
status
string
Response status
​
data
object
Cross-match matrix showing similarities between all sample pairs

​
Match Sample vs Sample

GET /matches/sample/{sample_id}/{sample_id_b}
Compares two specific samples.
​
sample_id
integer
required
ID of the first sample
​
sample_id_b
integer
required
ID of the second sample
​
minhash_threshold
float
Minimum MinHash similarity threshold
​
pichash_size
integer
PicHash size threshold
​
status
string
Response status
​
data
object
Detailed match results between the two samples

​
Match Function vs Function

GET /matches/function/{function_id}/{function_id_b}
Compares two specific functions.
​
function_id
integer
required
ID of the first function
​
function_id_b
integer
required
ID of the second function
​
status
string
Response status
​
data
object
Match details including:
  • MinHash similarity
  • PicHash comparison
  • Instruction sequence alignment
{
  "status": "successful",
  "data": {
    "function_id_a": 1,
    "function_id_b": 2,
    "minhash_similarity": 0.92,
    "pichash_match": true,
    "num_instructions_a": 250,
    "num_instructions_b": 248
  }
}

​
Get Function Matches

GET /matches/function/{function_id}
This endpoint is currently not implemented.
Would return all matches for a specific function against the database.

Build docs developers (and LLMs) love

Get started for freeTalk to us