> ## Documentation Index
> Fetch the complete documentation index at: https://docs.modo.link/llms.txt
> Use this file to discover all available pages before exploring further.

# How to Use API

To start using [Modo API](https://app.modo.link/home), you have to select a subscription plan.

<Frame>
  <img src="https://mintcdn.com/modo/57CRuKycPL1HNBla/images/image-20260413-223244.png?fit=max&auto=format&n=57CRuKycPL1HNBla&q=85&s=f8ae8fcb06961d806491faee4c50752b" alt="Image 20260413 223244" width="1650" height="766" data-path="images/image-20260413-223244.png" />
</Frame>

Use the assigned API key.

<Frame>
  <img src="https://mintcdn.com/modo/57CRuKycPL1HNBla/images/image-20260413-223601.png?fit=max&auto=format&n=57CRuKycPL1HNBla&q=85&s=49b9d8573c5a22e9dfa697baac9704ba" alt="Image 20260413 223601" width="1855" height="833" data-path="images/image-20260413-223601.png" />
</Frame>

Go to the [Canton API reference page](https://docs.modo.link/api-reference/events/get-events-list) of the API Documentation. Now, with the API key you've got, you can pick any endpoint to run.

<Frame>
  <img src="https://mintcdn.com/modo/57CRuKycPL1HNBla/images/image-20260413-223920-(1).png?fit=max&auto=format&n=57CRuKycPL1HNBla&q=85&s=f94d259db3b079282bd804c3d325f7e2" alt="Image 20260413 223920 (1)" width="1806" height="830" data-path="images/image-20260413-223920-(1).png" />
</Frame>

# Query Params

You have to specify the required parameters. They are marked with a tag and usually are: ***sortBy***, ***page***, ***size***, ***order***, and ***path*.**

You can also fill in the optional parameters to get a more targeted request.

<Frame>
  <img src="https://mintcdn.com/modo/57CRuKycPL1HNBla/images/image-20260413-225114.png?fit=max&auto=format&n=57CRuKycPL1HNBla&q=85&s=363a5914e24867eeaf3719d829867b64" alt="Image 20260413 225114" width="926" height="602" data-path="images/image-20260413-225114.png" />
</Frame>

<Danger>
  Unless you fill in all the required fields, the request won't work, and you'll get an error.
</Danger>

<Check>
  Modo API is here for you. Get the data you need!
</Check>

Read more:

<CardGroup cols={2}>
  <Card title="Pagination" href="/platform/pagination">
    Read about the pagination principles Modo API uses.
  </Card>

  <Card title="Error Reference" href="/platform/error-reference">
    Check the most common API errors and codes.
  </Card>

  <Card title="Modo API" href="/canton/modo-api">
    Read more about Modo API – a data platform on Canton.
  </Card>

  <Card title="API Dashboard" href="/canton/api-dashboard">
    View your API statistics in the API Dashboard.
  </Card>
</CardGroup>