Как создать правильно API запрос на Python?

Question

[Анастасия]

Хочу создать запрос на получение события о России в рамках даты, но не могу понять, как создать запрос с параметрами?

https://api-ninjas.com/api/historicalevents

day = 1
    month = 1
    text = 'russia'
    api_url = 'https://api.api-ninjas.com/v1/historicalevents?text={},day={},month={}'.format(text, month, day)
    response = requests.get(api_url, headers={'X-Api-Key': 'zd4vQLQ3nVfeG1W'})
    if response.status_code == requests.codes.ok:
        print(response.text)
    else:
        print("Error:", response.status_code, response.text)

Comments

[Алексей Уколов]

text={},day={},month={}'.format(text, month, day)

Как минимум, у вас перепутаны местами месяц и день в format, а разделителем get-параметров должны быть не запятые, а амперсанды (&).

[Анастасия]

Алексей Уколов,

api_url = 'https://api.api-ninjas.com/v1/historicalevents?text={}&day={}&month={}'.format(text&day&month)

такой вариант ?

[Николай Медведков]

Анастасия, нет, только в url должны быть эти штуки вместо запятых

[Алексей Уколов]

Нет, вам амперсанды нужны только в URL, разделять параметры метода format ими нельзя. Неужели вам редактор, в котором вы пишете код, не подсветил ошибку в этом месте?

[maksam07]

И почему ни кто не передает гет-параметр в аргументе парамс...

[d'Ivan]

Анастасия
Ключи API нужно маскировать перед публикацией. Это же элементарные правила безопасности. Этот ключ уже утёк в интернет и может быть кем-то использован.

[Shandy]

Иерокопус Таманский, тут с url и параметрами не разобрались, а вы про ключи)

Answer 1

[o5a]

Ошибка в том, что вместо запятых в тексте должны быть &.
Но лучше вообще вручную так строку не составлять. Для этого есть встроенная функция, которая сама конвертирует в строку, а заодно учтет и кодирование для спецсимволов и кириллицы.

from urllib.parse import urlencode

params = {
    "text":  'russia',
    "day": 1,
    "month": 1
}

param_str = urlencode(params)
# формируем полную ссылку
api_url = f'https://api.api-ninjas.com/v1/historicalevents?{param_str}'
print(api_url) # https://api.api-ninjas.com/v1/historicalevents?text=russia&day=1&month=1

Comments

[Анастасия]

Ваш вариант оказался рабочим в моей итерации.

params = {
            "text": 'russia',
            "day": 1,
            "month": 1,
            "offset": 1,
        }

        param_str = urlencode(params)
        # формируем полную ссылку
        api_url = f'https://api.api-ninjas.com/v1/historicalevents?{param_str}'
        #print(api_url)
        response = requests.get(api_url, headers={'X-Api-Key': }

ответ возвращается таким образом:

[{"year": "1860", "month": "01", "day": "01", "event": "The first Polish stamp is issued, replacing the Russian stamps previously in use."}, {"year": "1998", "month": "01", "day": "01", "event": "Following a currency reform, Russia begins to circulate new rubles to stem inflation and promote confidence."}, {"year": "2015", "month": "01", "day": "01", "event": "The Eurasian Economic Union comes into effect, creating a political and economic union between Russia, Belarus, Armenia, Kazakhstan and Kyrgyzstan."}]

Как вытащить только event в массив event = [] ?

event = [The first Polish stamp is issued, replacing the Russian stamps previously in use. Following a currency reform, Russia begins to circulate new rubles to stem inflation and promote confidence. The Eurasian Economic Union comes into effect, creating a political and economic union between Russia, Belarus, Armenia, Kazakhstan and Kyrgyzstan.]

Спасибо

[o5a]

Анастасия, это обычная работа с вложенными данными. В данном случае у вас список, внутри которого словарь. Т.е. сначала достаете первый (нулевой) элемент списка, затем уже в нем достаете значение по ключу "event".

[maksam07]

Человек использует requests, где есть соотв. аргумент для кодирования данных

Answer 2

[angeloffy]

import requests

day = 1
month = 1
text = 'russia'
api_key = 'api key'
api_url = f'https://api.api-ninjas.com/v1/historicalevents?text={text}&day={day}&month={month}'

response = requests.get(api_url, headers={'X-Api-Key': api_key})
if response.status_code == requests.codes.ok:
    print(response.text)
else:
    print("Error:", response.status_code, response.text)

Answer 3

[Xacker Name]

попробуй так:

import requests

# параметры запроса
day = 1
month = 1
text = 'russia'

# формирование url
api_url = 'https://api.api-ninjas.com/v1/historicalevents?text={},day={},month={}'.format(text, day, month)

# headers с ключом API
headers = {
    'X-Api-Key': 'zd4vQLQ3nVfeG1W'
}

# отправка запроса
response = requests.get(api_url, headers=headers)

# проверка ответа
if response.status_code == 200:
    print(response.json())
else:
    print("Error:", response.status_code, response.text)

Comments

[Анастасия]

спасибо. но не помогло ...

[Алексей Уколов]

Анастасия, как именно "не помогло"? Что вы видите после вызова этого кода в консоли?

[Дмитрий]

Алексей Уколов, Алексей, мне стало интересно, попробовал.
Вот такая конструкция работает

api_url = 'https://api.api-ninjas.com/v1/historicalevents?text={}&year={}'.format(text, year)

добавить день и месяц - аналогично, и судя по сайту - год, день, месяц - строковые.

Answer 4

[ImCocos]

Параметр data у метода get

Answer 5

[nekdan]

При использовании библиотеки requests можно стандартным способом передать нужные параметры и не будет необходимости формировать строку запроса.

import requests

api_url = 'https://api.api-ninjas.com/v1/historicalevents'
headers = {
    'X-Api-Key': 'zd4vQLQ3nVfeG1W'
}
params = {
    'text':  'russia',
    'day': 1,
    'month': 1
}

response = requests.get(api_url, headers=headers, params=params)

if response.status_code == 200:
    print(response.json())
else:
    print("Error:", response.status_code, response.text)