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: Directindex Org Deep API
version: '0.2'
contact:
url: https://directindex.org/
description: 'Operations tagged Deep across 2 of this provider''s published API definitions: openapi.json, directindex-org-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://directindex.org
security:
- {}
- apiKey: []
tags:
- name: Deep
paths:
/api/deep:
post:
summary: Order the paid deep report (5 EUR, one-off) for a business in a city index…
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- domain
- email
properties:
domain:
type: string
example: belcanto.pt
email:
type: string
example: owner@belcanto.pt
lang:
type: string
example: en
responses:
'201':
description: 'Order created: order (token), status, price, checkout (URL or null while deep reports are not on sale), links (status, page, markdown, json, pdf), next (what to do)'
'400':
description: Bad domain or email
'404':
description: The business is not in a city index
'429':
description: Six orders per business per day, thirty requests per hour per address
tags:
- Deep
operationId: postApiDeep
x-operation-id-source: derived
servers:
- url: https://directindex.org
/api/deep/{order}:
get:
summary: Status of a deep report order; links to the report as Markdown, JSON, page and…
parameters:
- name: order
in: path
required: true
schema:
type: string
responses:
'200':
description: status is pending, waitlist, paid, running, done or failed
'404':
description: No such order
tags:
- Deep
operationId: getApiDeepByOrder
x-operation-id-source: derived
servers:
- url: https://directindex.org
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'
x-refined-from:
- openapi.json
- directindex-org-openapi.json