Auto-Generating_API_Code

Using the API Documentation in Interactive mode

The API Documentation pages on this site offer an interactive mode where users can click on their selected criteria and the API call with the correct syntax will be auto-generated for them.
Follow these steps to switch to the interactive mode:

  1. Go to the method in the documentation that you want to test, e.g. /Search/query
  2. Click on the “Authorize” button at "API Query Builder" section on the left side and enter your API key to get access to the interactive mode
    image
    image
  3. Select all relevant parameters you want to include in your API query and click on "Add Parameter" button
    image
  4. Set values to the selected parameters and click on "Execute” button
    image
  5. You will get on the screen your API request HTTPS URl, as well as the response from this call
    image