Skip to content
Number Lookup API/Getting started/
Python
/
Look up a number
Last updated

Look up a number with Python

You can quickly see how the Number Lookup API works by looking up a number using the Python SDK.

In this guide you will learn:
  1. How to set up your Python application.
  2. Look up your phone number.

What you need to know before you start

Before you can get started, you need the following already set up:

Set up your Python application

To quickly get started setting up a simple client application using the Python SDK:

  1. If you haven't already, clone the sinch-sdk-python repository.
  2. Navigate to the examples/snippets folder.
  3. Copy the example .env file by running the following command:
cp .env.example .env
  1. Open the .env file you just created. Using the access key credentials from your Sinch Build Dashboard, populate the following fields with your values:
FieldDescription
SINCH_PROJECT_IDThe unique ID of your Project.
SINCH_KEY_IDThe unique ID of your access key.
SINCH_KEY_SECRETThe secret that goes with your access key.
Note: For security reasons, this secret is only visible right after access key creation.

  1. Save the file.

  2. The Python SDK uses Poetry to manage packages and dependencies, so install those dependencies using the following command:

poetry install

Modify your code

  1. Navigate to examples/snippets/number_lookup/lookup/ and open the snippet.py file.
snippet.py
# Use this code to look up a phone number using the Number Lookup API. 
"""
Sinch Python Snippet

This snippet is available at https://github.com/sinch/sinch-sdk-python/tree/main/examples/snippets
"""

import os
from dotenv import load_dotenv
from sinch import SinchClient

load_dotenv()

sinch_client = SinchClient(
    project_id=os.environ.get("SINCH_PROJECT_ID") or "MY_PROJECT_ID",
    key_id=os.environ.get("SINCH_KEY_ID") or "MY_KEY_ID",
    key_secret=os.environ.get("SINCH_KEY_SECRET") or "MY_KEY_SECRET",
)

# The phone number to look up in E.164 format (e.g. +1234567890)
phone_number = "PHONE_NUMBER"

response = sinch_client.number_lookup.lookup(number=phone_number)

print(f"Number lookup result:\n{response}")

  1. Before you can run the code, you need to update some values. Update the following parameters with your own values:

    Assign your values to the following parameters:

    ParameterYour value
    phone_numberThe phone number that you want to look up in E.164 format.

  2. Save the file.

Look up your phone number

Now you can execute the code and look up your phone number. Run the following command:

python examples/snippets/number_lookup/lookup/snippet.py

You should receive a response in your console with details about the phone number you specified.

Troubleshooting tip

If after running your app you receive a 5000 error response, you may have forgotten to save your file after adding your authentication values. This is an easy mistake to make! Try saving the file and running the app again.

Additional resources

Previous page