---
title: "List the user's trained models with pre-computed train/test stats"
method: GET
path: "/api/v1/models"
tags: ["Models"]
---

# List the user's trained models with pre-computed train/test stats

`GET /api/v1/models`

## Request

- Base URL: `https://api.quantifyme.ai`
- URL: `https://api.quantifyme.ai/api/v1/models`
- Auth: API key in header `X-API-Key`

## Query parameters

- `api_key` string

## Response `200`

Successful response

- ModelsList
  - `count` integer
  - `models` ModelInfo[]
    - `model_name` string
    - `name` string: PKL stem: <user_id>_<SYMBOL>_<timeframe>_<model_name>
    - `net_return` number, nullable: Net return of the backtest as a fraction (0.12 = +12%), as published to /community (total_ret); null when not stored
    - `sharpe` number, nullable: Sharpe ratio of the backtest, as published to /community (sharpe_strat); null when not stored, or when it rests on fewer than 5 trades or on trades that returned almost the same
    - `test_stats` TradeStats
      - `avg` number: Avg trade return (decimal pct)
      - `best` number
      - `expect` number: Expectancy ($/trade)
      - `losses` integer
      - `mdd` number: Max drawdown (decimal pct, signed)
      - `n` integer: Total trades
      - `np` number: Net profit ($)
      - `pf` number: Profit factor (gross wins / gross losses)
      - `ret` number: Total return (decimal pct)
      - `rr` number: Risk:Reward (avg win / avg loss)
      - `wins` integer
      - `worst` number
      - `wr` number: Win rate (0-1)
    - `train_stats` TradeStats
      - `avg` number: Avg trade return (decimal pct)
      - `best` number
      - `expect` number: Expectancy ($/trade)
      - `losses` integer
      - `mdd` number: Max drawdown (decimal pct, signed)
      - `n` integer: Total trades
      - `np` number: Net profit ($)
      - `pf` number: Profit factor (gross wins / gross losses)
      - `ret` number: Total return (decimal pct)
      - `rr` number: Risk:Reward (avg win / avg loss)
      - `wins` integer
      - `worst` number
      - `wr` number: Win rate (0-1)
    - `trained_at` string, date-time

## Other responses

- `400`: Bad request
- `401`: Invalid or missing API key
- `429`: Rate limit exceeded, or insufficient credits (body carries credits_remaining and credits_required)

---

[API](https://skmtc.dev/quantifyme/apis/quantifyme-api.md) · [All operations](https://skmtc.dev/quantifyme/apis/quantifyme-api/llms.txt) · [OpenAPI document](https://skmtc.dev/quantifyme/apis/quantifyme-api/revisions/089d1cee1ec5?raw)