# Felixcloutier — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Look up detailed x86/amd64 instruction information including opcodes, pseudocode operations, and exceptions, and search by instruction name or summary to understand how processor instructions work. Browse the complete instruction index or get comprehensive documentation for any specific assembly instruction.

**Category:** Developer Tools | **Website:** [felixcloutier.com/](https://felixcloutier.com/) | **Docs:** [parse.bot/marketplace/5a42d23a-bf31-4ebe-be63-2f10fea6f24e/felixcloutier-com-api](https://parse.bot/marketplace/5a42d23a-bf31-4ebe-be63-2f10fea6f24e/felixcloutier-com-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-felixcloutier-com-api-5a42d23a/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_instruction_detail

Fetches the complete reference documentation for a single x86 instruction identified by mnemonic. Returns structured data including the opcode table, operand encoding, prose description, operation pseudocode, flags affected, compiler intrinsics (when available), and processor exception tables (protected, real, v8086, compatibility, 64-bit modes). A separate round-trip per instruction; use the index or search endpoints to discover valid mnemonics first.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `mnemonic` | string | Yes | Instruction mnemonic, case-insensitive (e.g. ADD, MOV, IMUL, VADDPD). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-felixcloutier-com-api-5a42d23a/get_instruction_detail \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"mnemonic":"<string>"}'
```

### get_instruction_index

Retrieves the complete index of x86/amd64 instructions. Each entry contains the mnemonic, a brief summary of what the instruction does, and the URL path to its detail page. The index is a single-page static list (no pagination).

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-felixcloutier-com-api-5a42d23a/get_instruction_index \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_instruction_opcodes

Retrieves only the opcode encoding table for a specific instruction. Each row describes one encoding variant with opcode bytes, assembly syntax, operand encoding type, 64-bit mode validity, compatibility/legacy mode validity, and a prose description. A lighter alternative to get_instruction_detail when only encoding information is needed.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `mnemonic` | string | Yes | Instruction mnemonic, case-insensitive (e.g. MOV, ADD, IMUL, VADDPD). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-felixcloutier-com-api-5a42d23a/get_instruction_opcodes \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"mnemonic":"<string>"}'
```

### search_instructions_by_mnemonic

Filters the instruction index to entries whose mnemonic contains the query string (case-insensitive substring match). Returns the same shape as the index endpoint but limited to matches. Useful for discovering instruction families (e.g. query 'ADD' returns ADD, ADDPD, ADDPS, ADDSD, etc.).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Mnemonic search term, case-insensitive substring (e.g. ADD, MOV, MUL). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-felixcloutier-com-api-5a42d23a/search_instructions_by_mnemonic \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```

### search_instructions_by_summary

Filters the instruction index to entries whose summary description contains the query string (case-insensitive substring match). Useful for finding instructions by what they do (e.g. query 'multiply' returns MUL, IMUL, FMUL, etc.).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Summary search term, case-insensitive substring (e.g. multiply, compare, shift, packed). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-felixcloutier-com-api-5a42d23a/search_instructions_by_summary \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"<string>"}'
```