MicroBrew API Documentation

ByteBrew offers a API which gives access to app store metadata. You can get access to MicroBrew's API by utilizing your accounts API key. Get access to the MicroBrew Dashboard


MicroBrew API Authentication

1: Authenticate by retrieving a token.

Send a POST request to get a temporary 1 hour api token.

The request must have a JSON body containing the following:

- email
- apiKey
    
    // Request Link
    POST: https://micro-api.bytebrew.io/auth/generatetoken
    Body Data: 
    {
        "email": "someones@email.com",
        "apiKey": "A_VERY/LONG_SCRAMBLE_OF/ASCII.CHARACTERS_GIVEN.BY/TIM_THE.MAGICIAN"
    }
    
                      

The request will return a response containing the "token"

  
      {
          "token": "A_EVEN.LONGER/SCRAMBLE_OF_ASCII/CHARACTERS/GIVEN_BY.TIM.THE.MAGICIAN"
      }
  
                    
Every request for api data needs to have a Authorization Header:
  
      Authorization: Bearer A_VERY/LONG_SCRAMBLE_OF/ASCII.CHARACTERS_GIVEN.BY/TIM_THE.MAGICIAN
  
                    

App Data

Let's start getting the app store metadata we want.

1: API App Data Endpoint.

When building the url make sure to specify the app store you want in the path parameter "{platform}"

  
    GET Endpoint: https://micro-api.bytebrew.io/api/app/{platform}/find
        
    //iOS Example: https://micro-api.bytebrew.io/api/app/ios/find

    //Google Example: https://micro-api.bytebrew.io/api/app/google/find
  
                    
Attach Parameters

To further filter the data, you can specify multiple parameters in the query.

priority_highImportant: All queries must specify "apps".

priority_highImportant: TURBO and SUPER users are the only ones who have Keywords analysis, this will not be in the request for Free or Micro users.

The request can have the following parameters:

- apps : (Required) single or a list of coma seperated bundleIDs, package names, or apple app IDs (Free and Micro Plan users can't append more than one app in the request)
- country : alpha-2 Country Code. Defaults to "US"
- isAppID : Boolean specifying if the given apps are Apple App IDs. Defaults to False
Data Schema: (some app store platforms will have empty values becasue they aren't supported)

If the platform doesn't support the key it will be an empty string by default.

  
    "country" - Google|iOS
    "platform" - Google|iOS
    "bundle_id" - Google|iOS
    "ios_app_id" - iOS
    "screenshots" - Google|iOS
    "icon" - Google|iOS
    "genres" - Google|iOS
    "description" - Google|iOS
    "key_words" - Google|iOS 'SUPER' and 'TURBO' MicroBrew users only. This will not show up for 'FREE' and 'MICRO' users
    "store_name" - Google|iOS
    "app_state" - Google|iOS
    "pricing" - Google|iOS
    "installs_amount" - Google
    "last_updated" - Google|iOS
    "last_update_message" - Google|iOS
    "app_size" - Google|iOS
    "app_version" - Google|iOS
    "rating_count" - Google|iOS
    "avg_rating" - Google|iOS
    "developer_name" - Google|iOS
    "developer_address" - Google
    "developer_email" - Google
    "developer_website" - Google|iOS
    "app_privacy_policy" - Google
    "content_ratings" - Google|iOS
    "contains_ads" - Google
    "contains_iap" - Google
  
                    
Turbo or Super User Example:
  
      GET Endpoint: https://micro-api.bytebrew.io/api/app/google/find?apps=com.companyname.exampleapp,com.secondcompany.exampleapp
  
      Response: 
      {
        "timestamp": "2021-09-12T04:19:52.849Z",
        "apps_requested": [
            "com.companyname.exampleapp",
            "com.secondcompany.exampleapp"
        ],
        "data": [
            {
                "bundle_id": "com.companyname.exampleapp",
                "country": "us",
                "platform": "google",
                "app_privacy_policy": "",
                "app_size": "154M",
                "app_version": "1.1.1",
                "avg_rating": 4.32,
                "contains_ads": true,
                "contains_iap": true,
                "content_ratings": [
                    "Teen",
                    "Violence, Blood, Rabits"
                ],
                "description": "He who is valient and pure of spirit may find the holy grail in the castle of AAAUUUUGGGGHHHH.....",
                "developer_address": "Camelot Castle, Britain",
                "developer_email": "arthur@knight-o-table.com",
                "developer_name": "Knights Who Say NI!,
                "developer_website": "EKKI-EKKI-EKKI-PIANG.ZOOM-BOING",
                "genres": [
                    "Action"
                ],
                "key_words": [
                    "candies",
                    "craving",
                    "purchases",
                    "crush",
                    "going",
                    "tasty",
                    "candy",
                    "combos",
                    "king",
                    "game",
                    "boosters"
                    ...
                ]
                "icon": "icon-url.somewhere",
                "installs_amount": "50001-100000",
                "ios_app_id": "",
                "last_update_message": "Bug fixes - added coconuts",
                "last_updated": "April 13, 2021",
                "rating_count": 0,
                "screenshots": [
                    "some-url.to_the_appstores",
                    ...
                ],
                "store_name": "Journey for the Holy Grail",
                "app_state": "available",
                "pricing": "free"
            },
            {
                "bundle_id": "com.companyname.exampleapp",
                "country": "us",
                "platform": "google",
                ...
            }
        ]
    }
  
                    
Free or Micro User Example:
  
      GET Endpoint: https://micro-api.bytebrew.io/api/app/ios/find?apps=12345678&isAppID=true
  
      Response: 
      {
        "timestamp": "2021-09-12T04:19:52.849Z",
        "apps_requested": [
            "12345678"
        ],
        "data": [
            {
                "bundle_id": "com.companyname.exampleapp",
                "country": "us",
                "platform": "ios",
                "app_privacy_policy": "", //This Feature isn't available on iOS
                "app_size": "254M",
                "app_version": "0.1.1",
                "avg_rating": 3.92,
                "contains_ads": false, //This Feature isn't available on iOS
                "contains_iap": false, //This Feature isn't available on iOS
                "content_ratings": [
                    "Teen",
                    "Violence, Blood, Rabits"
                ],
                "description": "He who is valient and pure of spirit may find the holy grail in the castle of AAAUUUUGGGGHHHH.....",
                "developer_address": "", //This Feature isn't available on iOS
                "developer_email": "", //This Feature isn't available on iOS
                "developer_name": "Knights Who Say NI!,
                "developer_website": "", //This Feature isn't available on iOS
                "genres": [
                    "Action"
                ],
                "icon": "icon-url.somewhere",
                "installs_amount": "", //This Feature isn't available on iOS
                "ios_app_id": "12345678",
                "last_update_message": "Bug fixes - added coconuts",
                "last_updated": "April 13, 2021",
                "rating_count": 0,
                "screenshots": [
                    "some-url.to_the_appstores",
                    ...
                ],
                "store_name": "Journey for the Holy Grail",
                "app_state": "available",
                "pricing": "free"
            }
        ]
    }