felixcloutier.com APIfelixcloutier.com ↗
Access x86/amd64 instruction data: opcodes, pseudocode, flags, and exceptions for every instruction listed on felixcloutier.com.
No input parameters required.
curl -X GET 'https://api.parse.bot/scraper/5e838c46-f5f7-404c-b9e4-5bc1153a16fa/get_instruction_index' \ -H 'X-API-Key: $PARSE_API_KEY'
Get the full list of x86 instructions from the index page. Returns all available instruction mnemonics with their summaries and URLs.
No input parameters required.
{
"type": "object",
"fields": {
"data": "array of instruction objects, each with mnemonic, summary, path, and full_url"
},
"sample": {
"data": [
{
"path": "/x86/aaa",
"summary": "ASCII Adjust After Addition",
"full_url": "https://www.felixcloutier.com/x86/aaa",
"mnemonic": "AAA"
},
{
"path": "/x86/add",
"summary": "Add",
"full_url": "https://www.felixcloutier.com/x86/add",
"mnemonic": "ADD"
}
],
"status": "success"
}
}About the felixcloutier.com API
This API exposes x86/amd64 instruction reference data from felixcloutier.com across 5 endpoints, covering every instruction in the index along with full per-instruction documentation. The get_instruction_detail endpoint returns opcode tables, operation pseudocode, operand encoding, flags affected, intrinsics, and exception tables for any mnemonic you provide. Two search endpoints let you filter by mnemonic substring or by summary keyword.
Instruction Index and Search
The get_instruction_index endpoint returns the full instruction list with no required parameters. Each item in the response array includes a mnemonic, a plain-English summary, a relative path, and a full_url back to the source page. If you want a narrower result set, search_instructions_by_mnemonic accepts a query string and returns every instruction whose mnemonic contains that substring (case-insensitive). search_instructions_by_summary does the same match against the summary field — useful for finding all instructions related to a concept like "shift" or "compare" without knowing specific mnemonics.
Per-Instruction Detail
The get_instruction_detail endpoint accepts a single mnemonic parameter (case-insensitive) and returns a structured object with these fields: title, opcodes (the full opcode table), operand_encoding, description, operation (pseudocode as documented in the reference), flags_affected, intrinsics, and exceptions. This covers both the human-readable prose sections and the machine-readable tabular data in one response.
Opcode Table Only
When you only need encoding details, get_instruction_opcodes returns just the opcode rows for a given mnemonic. Each row includes columns like Opcode, Instruction, Op/En, 64-Bit Mode, Compat/Leg Mode, and Description. This is useful when you are building disassemblers, assemblers, or encoding validators and want a structured table without the surrounding documentation prose.
- Build a CLI tool that prints opcode encodings and mode support for any x86 mnemonic using
get_instruction_opcodes. - Populate an IDE plugin's inline documentation pane with instruction descriptions, pseudocode, and flags from
get_instruction_detail. - Generate a searchable offline instruction reference by pulling the full index via
get_instruction_indexand caching detail pages. - Cross-reference instruction exception tables when writing low-level fault handlers or hypervisor code.
- Find all instructions related to a hardware feature (e.g. "AES", "AVX") using
search_instructions_by_mnemonic. - Identify instructions that affect a specific flag by searching summaries with
search_instructions_by_summary. - Feed structured opcode data into an assembler test harness to verify encoding coverage against the reference.
| Tier | Price | Credits/month | Rate limit |
|---|---|---|---|
| Free | $0/mo | 100 | 5 req/min |
| Hobby | $30/mo | 1,000 | 20 req/min |
| Developer | $100/mo | 5,000 | 250 req/min |
One credit = one API call regardless of which marketplace API you call. Exceeding the rate limit returns a 429 response. Authenticate with the X-API-Key header.
Does felixcloutier.com have an official developer API?+
What does `get_instruction_detail` return for the `operation` field?+
operation field contains the pseudocode block as it appears in the instruction documentation — the same algorithmic description used in Intel's official SDM. It is returned as a string and preserves the structure of the original reference text.Does the API cover EVEX-encoded (AVX-512) instructions and their opcode variants?+
get_instruction_opcodes include EVEX variants where they exist in the source. Instructions not present in the felixcloutier.com index are not returned.Can I retrieve the exception tables broken down by exception class or type?+
exceptions field in get_instruction_detail returns the exception data as documented per instruction, but the API does not expose a cross-instruction endpoint to query by exception class. You can fork this API on Parse and revise it to add a filtered exceptions endpoint that aggregates across instructions.Does the API support pagination for the instruction index?+
get_instruction_index returns the complete instruction list in a single response with no pagination parameters. The full index for x86 runs to several hundred entries, all returned at once. If you need server-side pagination, you can fork the API on Parse and revise it to add limit and offset parameters.