Getting started with MythX security tools

This page will show how to start using MythX in the shortest number of steps.

Creating an account

To use MythX, you need to create an account.

  1. Go to https://mythx.io and click the Sign Up button on the top right.

  2. Fill out the registration form. You will need to supply a valid email address.

    ../_images/registration2.png
  3. When finished, click Complete Registration.

  4. A success message will show, indicating your account has been created successfully. You will be sent an email to verify your email address.

    ../_images/success.png

Note

It is recommended that you link your Ethereum account to your profile as you will use this credential along with your password to access the MythX API via client tools such as Remix. This is done with MetaMask.

../_images/metamask1.png

Once linked, MetaMask will ask to sign a transaction to connect to MythX.

../_images/metamasksignup.png

Linking your account with tools

Your account, once verified, is on the Free plan.

Note

MythX offers both free and paid plans. For information on plans and features, please see our Pricing page.

If using one of the MythX tools & integrations, you will need to link your account to the tool to take advantage of your account’s plan.

While the specifics of each tool differ, most tools will pick up your account information when stored in your system’s environment variables.

Environment variable Value
MYTHX_API_KEY <Your API key>

MythX uses an API key for authentication. This API key can be generated in your dashboard. In the Profile tab there is a section titled MythX API Key. Generate a new API key by entering your account password:

../_images/api-key-password.png

On successful authentication, a new API key is generated, which can be used for further authentication by API clients. It will only be shown once, and can be copied using the icon on the right of the truncated secret string. If the token is lost, a new one can be generated again in the same way as explained above.

../_images/api-key.png

This key can be passed to MythX as an environment variable MYTHX_API_KEY.

  • Linux / macOS:

    export MYTHX_API_KEY='put your API key here!'
    
  • Windows:

    set MYTHX_API_KEY='put your API key here!'
    

Note

Although using the API key is the recommended means of authentication, there are certain tools that do not yet support the API token (for example: Remix). For these tools, you can authenticate via your Ethereum address or user name and password.

Please see the specific page for your tool to see more details about linking your account.