Number of APIs: 60
Welcome to the technical overview of the Modash API. Below we outline the best practices, error codes, and how to access the API. If you have any questions about the process or pricing, you can contact us at hello@modash.io. [ All requests to the API must be authenticated. You can get your access token from https://marketer.modash.io/developer. Use the access token as: If the API returns errors then the HTTP status code is different from Resources might have more documented errors. These will be documented in the responses section in the routes descriptions. For error handing use the Rate limiting errors are always with the HTTP status code In case of any failed responses, e.g. HTTP status code You can test out the Instagram Search API for free by leaving the filter object empty. Your request body should look similar to this. To test out the Instagram Reports API for free you can set the 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. 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 By default the When finding influencers by interests, locations or brands you need to search by their respective ID. To list all interests, locations or brands you need to call the You can specify the list of interests, locations or brands returned by using the By default the Similar to interests, locations and brands, you first need to find the correct language code to search by. This can be done by calling the Contact Support:]
Authentication
Authorization
header field where the value is in the format Bearer {token}
access_token
body parameteraccess_token
query parameterError codes
200
(corresponding 4xx
or 5xx
code)
and error details are formatted as such:{
"error": true,
"code": "…", // documented below
"message": "…"
}
Code
Message
api_token_invalid
A valid API token is needed. Please visit the account developer section.
bad_request
Search keyword undefined. Please pass the search keyword id as a query parameter
bad_request
Comment id undefined. Please pass the comment id as a query parameter
bad_request
Hashtag undefined. Please pass the hashtag as a query parameter
bad_request
Media shortcode undefined. Please pass the media code as a query parameter
bad_request
Url query parameter undefined or has a bad format
handle_not_found
No public account was found by that handle. It's possible the influencer has been removed or has a private account.
account_not_found
Requested account does not exist
media_not_found
Media ID not found
entity_not_found
Requested entity does not exist
private_account
Requested account is private
empty_audience
We have no audience for this account.
retry_later
We are currently processing the data for this account. Please try again in a couple of hours.
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.
code
because messages might change over time without any notice.Rate Limiting Errors
429
. Please read the HTTP status code and handle the errors accordingly.Billing for Failed Requests
500
(Internal Server Error), we want to assure you that you will not incur any charges or consume any credits/limits. These failed requests are considered non-billable events.Testing the API
Search
> POST https://api.modash.io/v1/instagram/search
{
"sort": {
"field": "followers",
"direction": "desc"
},
"filter": {
}
}
Reports
userId
as instagram
.
Your request should look like this.> GET https://api.modash.io/v1/instagram/profile/instagram/report
Pagination
page
parameter in the request body.page
parameter is set to 0
.Searching by interests, locations, partnerships (brands) or languages
Interests, Locations and brands
https://api.modash.io/v1/instagram/interests
, https://api.modash.io/v1/instagram/locations
, https://api.modash.io/v1/instagram/brands
route.query
parameter and limit the amount of list items returned by using the limit
parameter.limit
parameter is set to 20
. You can query all list items by setting the limit
parameter to 0
.Languages
https://api.modash.io/v1/instagram/languages
route.
Name: API Support
Email: hello@modash.io
GET {{baseUrl}}/v1/raw/tiktok/challenge-info?url=<string>
GET {{baseUrl}}/v1/raw/tiktok/user-info?url=<string>
GET {{baseUrl}}/v1/raw/tiktok/user-feed?url=<strin
ENDPOINTS