Skip to content

Instantly share code, notes, and snippets.

@corrieriluca

corrieriluca/App-Store-Connect-API-Python.md

Last active August 9, 2025 01:12
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save corrieriluca/3c9f062401582dad83013d7363741b0c to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save corrieriluca/3c9f062401582dad83013d7363741b0c to your computer and use it in GitHub Desktop.
Download ZIP
Connection to the App Store Connect API using Python3
Raw
App-Store-Connect-API-Python.md

How to connect to the App Store Connect API using Python3

You will need the requests and authlib packages. Just run :

$ pip install requests authlib

Then you need to generate an API Key from the App Store Connect portal (https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api).

In the Python code below, replace the values of KEY_ID, ISSUER_ID and PATH_TO_KEY with your own.

You can change the URL of the request you want to make with the URL variable.

Finally, if you have some query parameters to pass in, use the params parameter of requests.get() (or requests.post()).

Raw
appstoreconnect-api.py
import requests, time, json
from authlib.jose import jwt
KEY_ID = "XXXXXXXXXX"
ISSUER_ID = "XXXXXX-XXXXXXX-XXXXXX-XXXXXXX"
EXPIRATION_TIME = int(round(time.time() + (20.0 * 60.0))) # 20 minutes timestamp
PATH_TO_KEY = 'path/to/your/key.p8'
with open(PATH_TO_KEY, 'r') as f:
PRIVATE_KEY = f.read()
header = {
"alg": "ES256",
"kid": KEY_ID,
"typ": "JWT"
}
payload = {
"iss": ISSUER_ID,
"exp": EXPIRATION_TIME,
"aud": "appstoreconnect-v1"
}
# Create the JWT
token = jwt.encode(header, payload, PRIVATE_KEY)
# API Request
JWT = 'Bearer ' + token.decode()
URL = 'https://api.appstoreconnect.apple.com/v1/users'
HEAD = {'Authorization': JWT}
r = requests.get(URL, params={'limit': 200}, headers=HEAD)
# Write the response in a pretty printed JSON file
with open('output.json', 'w') as out:
out.write(json.dumps(r.json(), indent=4))
@da-eos
Copy link

da-eos commented Aug 26, 2021

If you have the same problem 401 ->
check your jwt encode in https://jwt.io, just paste in form Encoded your token after jwt.encode. You must see correct headers and payload. It helps me to find error.

@yangyubo
Copy link

yangyubo commented Jan 17, 2022 •
edited
Loading

Thank you very much for the sample code, I rewrote this sample with Applaud:

import os
from applaud.connection import Connection

KEY_ID = "XXXXXXXXXX"
ISSUER_ID = "XXXXXX-XXXXXXX-XXXXXX-XXXXXXX"
PATH_TO_KEY = os.path.expanduser('path/to/your/key.p8')

with open(PATH_TO_KEY, 'r') as f:
    PRIVATE_KEY = f.read()

# Create the Connection
connection = Connection(ISSUER_ID, KEY_ID, PRIVATE_KEY)
# API Request
r = connection.users().limit(10).get()

# Print user names
for user in r.data:
    print(user.attributes.username, user.attributes.first_name, user.attributes.last_name)

Applaud handles the details of JWT, you don't have to worry about expiration time. You can find the fork here: How to connect to the App Store Connect API using Python3 and Applaud

@nelsonspbr
Copy link

nelsonspbr commented Jun 3, 2022

Thank you. I was getting 401 NOT_AUTHORIZED, changing expiration to 10 minutes fixed it.

@tanuj2207
Copy link

tanuj2207 commented Sep 11, 2022

Where to find "path_to_key" ?
Anyone please reply fast is possible!!!

Thankyou in Advanced

@sompodsign
Copy link

sompodsign commented Dec 7, 2022

@tanuj2207 You can get it from app store key section.

@Jana1977
Copy link

Jana1977 commented Feb 24, 2023

getting this error
JWT = 'Bearer ' + token.decode()
AttributeError: 'str' object has no attribute 'decode'

@Jana1977
Copy link

Jana1977 commented Feb 24, 2023

anyone ran into this error in the past ?

@alex-childish
Copy link

alex-childish commented Aug 1, 2023

Thank you! Apple also seems to require "bid" (bundle id) param for JWT payload now - at least it kept giving me 401 until I added it. Here's how their current payload example looks like:

{
  "iss": "57246542-96fe-1a63e053-0824d011072a",
  "iat": 1623085200,
  "exp": 1623086400,
  "aud": "appstoreconnect-v1",
  "bid": "com.example.testbundleid2021"
}

@divyanshustaq
Copy link

divyanshustaq commented Nov 21, 2023

Hi @alex-childish,

where did you get "bid"?

@alex-childish
Copy link

alex-childish commented Nov 22, 2023

@divyanshustaq

In app settings: https://support.appsflyer.com/hc/en-us/articles/360013555718-Finding-the-Apple-bundle-ID

I believe you can also get it via API:
https://developer.apple.com/documentation/appstoreconnectapi/list_bundle_ids

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment