Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Direct Index R API
version: '0.2'
description: 'Agent-Direct Scores: whether AI agents can find, read and act on a business''s own website. Free, open data, no authentication for reads. An API key (optional, agency plan) only raises the scan limit.'
contact:
url: https://directindex.org/
servers:
- url: https://directindex.org
security:
- {}
- apiKey: []
tags:
- name: R
paths:
/r/{domain}/menu.json:
get:
summary: The menu of a business in a city index as data, read from its own PDF or menu…
parameters:
- name: domain
in: path
required: true
schema:
type: string
- name: t
in: query
required: false
schema:
type: string
responses:
'200':
description: domain, name, currency, source, items, sections (name, items with name, description, price); the full document adds the HTML fragment
'404':
description: No menu page yet; the answer says how one is made
tags:
- R
operationId: getRByDomainMenuJson
x-operation-id-source: derived
components:
securitySchemes:
apiKey:
type: http
scheme: bearer
bearerFormat: di_live_ followed by 32 hex characters
description: 'Optional. Raises the new-scan limit to the key''s own (300 an hour on the agency plan) and attributes the call to the key; reads need no key and stay unlimited. Keys come with the agency plan: https://directindex.org/agency. Details: https://directindex.org/auth.md'