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 Scan API
version: '0.2'
contact:
url: https://directindex.org/
description: 'Operations tagged Scan 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: Scan
paths:
/api/scan:
post:
summary: Start a scan, or return the cached result if under 24 hours old
security:
- {}
- apiKey: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- url
properties:
url:
type: string
example: yourbusiness.com
responses:
'200':
description: Cached summary
'202':
description: Scan started
content:
application/json:
schema:
type: object
properties:
jobId:
type: string
page:
type: string
'429':
description: 'Rate limited: 30 new scans per hour per address, or the key''s own limit with an API key'
tags:
- Scan
operationId: postApiScan
x-operation-id-source: derived
servers:
- url: https://directindex.org
/api/scan/{jobId}:
get:
summary: Status and summary of a scan job
parameters:
- name: jobId
in: path
required: true
schema:
type: string
responses:
'200':
description: status is queued, running, complete or errored; result holds the summary when complete
tags:
- Scan
operationId: getApiScanByJobId
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