List Codes

curl --request GET \
  --url 'https://api.example.com/codes?HAIQU_API_KEY='

{
  "items": [
    {
      "slug": "<string>",
      "name": "<string>",
      "family": "<string>",
      "code_type": "<string>",
      "completeness": "<string>",
      "sub_family": "",
      "n": 123,
      "k": 123,
      "d": 123,
      "description": "<string>",
      "stabilizers": {},
      "logical_operators": {},
      "layout_svg_url": "<string>",
      "qecx_url": "<string>",
      "references": [
        {
          "authors": [
            "<string>"
          ],
          "title": "<string>",
          "year": 123,
          "doi": "<string>",
          "annotation": "<string>"
        }
      ]
    }
  ],
  "total": 123,
  "page": 123,
  "page_size": 123
}

API Reference

List Codes

Endpoint to list QEC codes with optional filtering and pagination.

Args: family: Filter by code family (e.g., “stabilizer”, “subsystem”, “bosonic”). sub_family: Filter by code sub-family (e.g., “rotated_surface”, “xzzx_surface”). code_type: Filter by code type (e.g., “CSS”, “non-CSS”). completeness: Filter by completeness level (“full”, “partial”, “metadata_only”). n: Filter by code distance n. d: Filter by code distance d (for non-CSS codes, d can be a dict with separate distances for X and Z errors). q: Search query to match against code name and slug (case-insensitive, prefix match). page: Page number for pagination (default: 1). page_size: Number of items per page for pagination (default: 20).

Returns: A paginated list of QEC codes matching the filters, along with the total count.

GET

codes

List Codes

curl --request GET \
  --url 'https://api.example.com/codes?HAIQU_API_KEY='

{
  "items": [
    {
      "slug": "<string>",
      "name": "<string>",
      "family": "<string>",
      "code_type": "<string>",
      "completeness": "<string>",
      "sub_family": "",
      "n": 123,
      "k": 123,
      "d": 123,
      "description": "<string>",
      "stabilizers": {},
      "logical_operators": {},
      "layout_svg_url": "<string>",
      "qecx_url": "<string>",
      "references": [
        {
          "authors": [
            "<string>"
          ],
          "title": "<string>",
          "year": 123,
          "doi": "<string>",
          "annotation": "<string>"
        }
      ]
    }
  ],
  "total": 123,
  "page": 123,
  "page_size": 123
}

Authorizations

HAIQU_API_KEY

string

query

required

Query Parameters

family

string[] | null

sub_family

string[] | null

code_type

string[] | null

completeness

string[] | null

integer[] | null

string | null

page

integer

default:1

page_size

integer

default:20

Response

Successful Response

Pydantic model for the QEC Code Library list API response.

items

QECCodeModel · object[]

required

Show child attributes

total

integer

required

page

integer

required

page_size

integer

required

Load Classical Data With Data Loading Get Code

⌘I

Documentation Index

Authorizations

Query Parameters

Response