iTC Reporter

What?

This script mimics the official App Store Connect Reporter by Apple which is used to automatically retrieve Sales- and Financial Reports for your App Store sales. It is written in pure Python and doesn't need a Java runtime installation. Opposed to Apple's tool, it can fetch App Store Connect login credentials from the macOS Keychain in order to tighten security a bit. Also, it goes the extra mile and unzips the downloaded reports.

Before Apple in 2018 decided to rebrand it, App Store Connect used to be called iTunes Connect or iTC in short – hence the name of this script.

Why?

Once upon a time, there was autoingestion …

In the past, Apple has provided a tool called autoingest for automated retrieving of sales reports from App Store Connect. While this tool worked quite reliably, it needed a full blown Java Runtime Environment installed.

… nowadays, it's all about Reporter

Apple has shut down autoingestion on December 13th, 2016. Fortunately, it has been replaced by a new and a bit more streamlined tool called Reporter. Unfortunately, Reporter is based on Java, too. It also suffers from a minor but annoying security threat as it needs to read App Store Connect login credentials from a cleartext file.

Java really is a sledge hammer to crack this nut

There really is no compelling reason to employ a Java tool with its somewhat heavyweight dependency on JRE in order to download a few reports from App Store Connect. Apart from the Apple backend engineering staff really being into Java, apparently. Also, storing login credentials in cleartext isn't state of the art anymore.

iTC Reporter (this Python script), on the other hand, solves both problems. It is written in pure Python and doesn't need Java or any external dependencies to function. Also, it can optionally read the App Store Connect access token from the OS X Keychain (though it generally is still advisable to use an extra Apple ID specifically created for retrieving reports!).

How?

The argument names and values of this script have mostly been chosen to be consistent with Apple's documentation for Reporter. To get a quick overview, here is the output of ./reporter.py -h:

usage: reporter.py [-h] [-a ACCOUNT] [-m {Normal,Robot.XML}] -u USERID
                   {getStatus,getAccounts,getVendors,getVendorsAndRegions,getReportVersion,getFinancialReport,getSalesReport,getSubscriptionReport,getSubscriptionEventReport,getSubscriberReport,getNewsstandReport,getOptInReport,getPreOrderReport,generateToken,viewToken,deleteToken}
                   ...

Reporting tool for querying Sales- and Financial Reports from App Store Connect

optional arguments:
  -h, --help            show this help message and exit
  -a ACCOUNT, --account ACCOUNT
                        account number (needed if your Apple ID has access to
                        multiple accounts; for a list of your account numbers,
                        use the 'getAccounts' command)
  -m {Normal,Robot.XML}, --mode {Normal,Robot.XML}
                        output format: plain text or XML (defaults to
                        'Normal')

required arguments:
  -u USERID, --userid USERID
                        Apple ID for use with App Store Connect

commands:
  Specify the task you want to be carried out (use -h after a command's name
  to get additional help for that command)

  {getStatus,getAccounts,getVendors,getVendorsAndRegions,getReportVersion,getFinancialReport,getSalesReport,getSubscriptionReport,getSubscriptionEventReport,getSubscriberReport,getNewsstandReport,getOptInReport,getPreOrderReport,generateToken,viewToken,deleteToken}
    getStatus           check if App Store Connect is available for queries
    getAccounts         fetch a list of accounts accessible to the Apple ID
                        given in -u
    getVendors          fetch a list of vendors accessible to the Apple ID
                        given in -u
    getVendorsAndRegions
                        fetch a list of financial reports you can download by
                        vendor number and region
    getReportVersion    query what is the latest available version of reports
                        of a specific type and subtype
    getFinancialReport  download a financial report file for a specific region
                        and fiscal period
    getSalesReport      download a summary sales report file for a specific
                        date range
    getSubscriptionReport
                        download a subscription report file for a specific day
    getSubscriptionEventReport
                        download an aggregated subscriber activity report file
                        for a specific day
    getSubscriberReport
                        download a transaction-level subscriber activity
                        report file for a specific day
    getNewsstandReport  download a magazines & newspapers report file for a
                        specific date range
    getOptInReport      download contact information for customers who opt in
                        to share their contact information with you
    getPreOrderReport   download a summary report file of pre-ordered items
                        for a specific date range
    generateToken       generate a token for accessing App Store Connect (expires
                        after 180 days) and optionally store it in the macOS
                        Keychain
    viewToken           display current App Store Connect access token and its
                        expiration date
    deleteToken         delete an existing App Store Connect access token

For a detailed description of report types, see
http://help.apple.com/itc/appssalesandtrends/#/itc37a18bcbf

Prerequisites

Obtaining an App Store Connect access token

Since end of July 2017, Apple requires the use of access tokens instead of passwords for Reporter. To generate an access token for an Apple ID, log in to App Store Connect using the Apple ID that you plan to use with reporter.py. Go to Sales and Trends > Reports, then click on the tooltip next to About Reports. Click Generate Access Token.

Or, instead of doing these steps manually, you can just let reporter.py fetch a token for you from App Store Connect. In addition, let's conveniently store it for future use in the macOS Keychain as an item named "iTC Access Token":

./reporter.py -u your@apple-id.com generateToken -P YourAppleIDPassword --update-keychain-item "iTC Access Token"

Your new access token has been generated.
AccessToken:4fbd6016-439d-4cef-a72e-5c465f8343d4
Expiration Date:2018-01-27
Keychain has been updated.

Storing credentials securely with Keychain

As access tokens expire after 180 days it probably is desirable to make the process of getting a new one automatable. But what about the cleartext Apple ID password following the -P parameter? It definitely should be fetched from Keychain, too, instead of having to pass it on the command line! To accomplish this, you need to manually create a keychain item holding your password. To do so, open the Keychain Access.app, select the default keychain, press ⌘N and fill in your Apple ID’s password. The item name you set for this new keychain entry is going to be what you have to supply for the -p (now lowercase!) parameter from now on. The command for obtaining a new access token now looks like this:

./reporter.py -u your@apple-id.com generateToken -p "iTC Password" --update-keychain-item "iTC Access Token"

Please note: Refreshing your access token using this command is only necessary after expiration (usually meaning every 180 days)! You can check for expiration with the viewToken command.

Usage examples

You are now equipped for regular use of this script by supplying your access token with the -t parameter. The following example queries App Store Connect's availability status for financial reports while fetching the access token from the Keychain item named "iTC Access Token":

./reporter.py -u your@apple-id.com getStatus Finance -t "iTC Access Token"

Querying accessible accounts

Because your Apple ID could have access to multiple accounts, you will sometimes need to specify the account number you’d like to use. Use the following query to find out which accounts are available:

./reporter.py -u your@apple-id.com getAccounts Sales -t "iTC Access Token"

The result is a list of account numbers you can then specify with the -a or --account argument in later queries regarding sales reports. Similarly, you'd use getAccounts Finance in order to find out account numbers that can be used for financial report queries.

Retrieving reports

Let's get to the point of this tool now: Retrieving reports from App Store Connect. To find out which vendor numbers you can query, you'll first need to get a list of available vendors, using (one of) the account number(s) you have found out with getAccounts before:

./reporter.py -u your@apple-id.com --account 2821955 getVendors -t "iTC Access Token"

The resulting vendor number(s) can then be used to get the actual reports. In the following example, a sales report listing the sales of a single day (2017/07/18) for vendor 85442109 is going to be retrieved:

./reporter.py -u your@apple-id.com -a 2821955 getSalesReport 85442109 Daily 20170718 -t "iTC Access Token"

Likewise, the following example fetches a financial report for sales in the US region in the first period of 2017 (according to Apple's fiscal calendar):

./reporter.py -u your@apple-id.com -a 2821955 getFinancialReport 85442109 US 2017 01 -t "iTC Access Token"

These examples should do for a quick introduction. Don't forget to read Apple's reference documentation for Reporter. Also, you can get further help for a specific command by supplying -h after the command's name. For example:

./reporter.py getFinancialReport -h

What's still missing

There seem to be additional report types available for retrieving Apple Music related data, but I wonder if anybody using this script would really need it.

Obligatory disclaimer

There is absolutely no warranty. I do not guarantee in any way that this tool works as intended or is fully compatible with Apple's official Reporter tool.

Pull Requests

Neither English nor Python are my native language – corrective PRs (even for style only) are very welcome!