Формати відповідей

Один ресурс пошуку - шість варіантів запису відповіді. Вибирайте через format=; JSON використовується за замовчуванням, і решту форматів описано відносно нього.

formatContent-TypeВигляд
jsonapplication/jsonОдин об’єкт, результати - в масиві.
ndjsonapplication/x-ndjsonОдин JSON-об’єкт на рядок. Перший рядок - метадані з позначкою "object":"meta".
xmlapplication/xmlТой самий документ у XML, рядки - як <result>.
csvtext/csvРоздільник - крапка з комою, без рядка заголовків.
tsvtext/tab-separated-valuesЯк CSV, роздільник - табуляція.
txttext/plainОдин URL на рядок.

jsonl приймається як інша назва для ndjson.

Що вибрати

json - для всього, що вміщується в пам’ять. ndjson - для всього, що не вміщується: немає зовнішнього масиву, на який треба чекати, метадані надходять раніше за рядки, і читач може почати обробляти перший результат, поки решта ще надходить. csv, tsv і txt - для електронних таблиць, конвеєрів командного рядка і для перенесення скрипту зі старих URL експорту без зміни його парсера.

ndjson

{"object":"meta","query":"\"angular.min.js\"","page":1,"per_page":2,"total":278,"total_pages":139,"returned":2,"truncated":false,"took_ms":2}
{"domain":"imgbox.com","url":"https://imgbox.com/","rank":4187,"ranked":true}
{"domain":"angularjs.org","url":"https://angularjs.org/","rank":12376,"ranked":true}

Вибір колонок

json і xml повертають усі поля. Пласкі формати натомість за замовчуванням повертають звичні колонки, тож скрипту, що переходить зі старих URL експорту, не потрібно міняти парсер:

ЗапитРезультат
format=csvimgbox.com;4187
format=csv&columns=url,rankhttps://imgbox.com/;4187
format=csv&columns=domainimgbox.com
format=txthttps://imgbox.com/
format=csv&snippets=1imgbox.com;4187;the matching text
format=csv&header=1спочатку рядок domain;rank
format=csv&delimiter=,imgbox.com,4187

columns працює для будь-якого формату, тож format=json з columns=domain повертає об’єкти лише з цим полем.

Особливості пласких форматів

Це власні формати нового API, а не перевидання старих експортів. Вигляд навмисно знайомий, але точну відповідність байт у байт гарантують лише старі URL.

Формати й помилки

csv, tsv і txt призначені лише для рядків, тому запит одного з них до /v1/account дає 400 format_not_available. Самі помилки повертаються в JSON або в XML, якщо запитано саме його.

Далі Ліміти й обмеження частоти