Modash API Documentation

Modash.io API (Legacy)

Number of APIs: 41

Introduction

Welcome to the technical overview of the Modash API. Below we outline some best practices, error codes and how to access and use the API.

If you have any questions about the process or pricing, you can contact us at hello@modash.io.

Authentication

You can get your access token from https://marketer.modash.io/developer.

All requests are authenticated based on a bearer token contained in the:

Authorization header field where the value is in the format Bearer {token}
or access_token body parameter
or access_token query parameter

Error codes

If API returns errors then HTTP status code is different from 200 (corresponding 40x or 50x code) and error details are formatted as such:

{
    "error": true,
    "code": Code,
    "message": "…"
}

Possible values for error codes are below. If the request can return something else it is specified in the corresponding request description.

Code	Explanation
`api_token_invalid`	A valid API token is needed. Please visit the account developer section.
`handle_not_found`	No public account was found by that handle. It's possible the influencer has been removed or has a private account.
`empty_audience`	We have no audience for this account.
`retry_later`	We are currently processing the data for this account. Please try again in 5-10 minutes.
`not_enough_credits`	You have ran out of credits. Contact support for further information.
`internal_server_error`	Our server is experiencing problems processing your request. We have been notified and will look into this.
`invalid_body_params`	You have sent invalid body parameters. Please verify your request using the documentation.
`feature_not_available`	This feature is not available for your account. Contact us for enabling the feature.
`no_result`	No result found for this query, try changing filters and please verify your request using the documentation.
`page_limit`	You have reached the maximum page limit. Please contact support.

Getting started

Below is an overview of how to set up and confirm the connection to our API. Before getting started, you will need to have been authenticated.

If there are any questions during the process, please contact support at hello@modash.io.

Testing out the API

Search

You can test out the Instagram Search API for free by leaving the filter object empty. Your request body should look similar to this.

> POST https://api.modash.io/v1/instagram/search
{
    "sort": {
        "field": "followers",
        "direction": "desc"
    },
    "filter": {
    }
}

Reports and Overviews

To test out the Instagram Reports API for free you can set the userId as instagram. Your request should look like this.

> GET https://api.modash.io/v1/instagram/profile/instagram/report

We recommend always using the report route and caching the result if necessary. Everything that is included in the overview is also in a report.

Pagination

When using the Search API, each response has in total 15 influencers. If you wish to query more influencers for the same query you need to increment the page parameter in the request body.

By default the page parameter is set to 0.

Searching by interests, locations or languages

Interests and Locations

When finding influencers by interests or locations you need to search by their respective ID. To list all interests or locations you need to call the https://api.modash.io/v1/instagram/interests or https://api.modash.io/v1/instagram/locations route.

You can specify the list of interests or locations returned by using the query parameter and limit the amount of list items returned by using the limit parameter.

By default the limit parameter is set to 20. You can query all list items by setting the limit parameter to 0.

Languages

Similar to interests and locations, you first need to find the correct language code to search by. This can be done by calling the https://api.modash.io/v1/instagram/languages route.

Contact Support: Name: API Support Email: hello@modash.io

FAQs
More
Claim this page
Report this page

ENDPOINTS