Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

IDAPython SDK

IDAPython SDK allows you to use the Python code in IDA to write scripts and customize basic IDA functionality. It offers more advanced and powerful automation than the IDC language and gives you access to Python modules and native Python abilities to interact with our API.

Where to find the IDAPython SDK?

  • IDA Pro: IDAPython SDK is shipped out-of-the-box with IDA Pro. You can find it int the python folder located in your IDA intallation directory.
  • Other IDA Products: Check our IDA SDK GitHub repository

Resources

IDAPython Referencehttps://python.docs.hex-rays.com/
IDA SDK Source Code on GitHub https://github.com/HexRaysSA/ida-sdk

Typical use cases

When you are asking yourself how to automate work in IDA, like renaming variables or performing custom analyses, the IDAPython API comes in handy. You can use simple code snippets directly inside the IDA output window to perform specific tasks or more advanced scripts for complex usage. Moreover, with IDAPython, you can write plugins to expand basic IDA capabilities even further.

Looking for a beginner-friendly entry point?

We’ve got you covered. The Domain API, built on top of the IDAPython SDK, provides a simple and intuitive starting point for those new to scripting in IDA. For more advanced use cases or finer control, you can fall back to the IDAPython SDK. The Domain API is fully compatible with the IDAPython SDK, so both can be used together to complement each other.

What to check next?

IDAPython Getting StartedCheck this guide to kickstart learning IDAPython with simple snippets.idapython-getting-started.md
IDAPython ExamplesDig into complex examples that showcase the full potential and versatility of our PythonAPI.migration-guides.md
IDAPython ReferenceExplore the technical details of all functions, classes, and more.https://python.docs.hex-rays.com
Writing Plugins in IDAPythonLearn the best practices for creating plugins with IDAPython.how-to-create-a-plugin.md

IDAPython Porting Guide

Check out our Porting Guide, which is prepared to help you migrate and adapt your existing scripts and plugins from IDA 8.x to IDA 9.0.