# ndxer

> ndxer answers DNS questions in both directions over a read-only HTTPS JSON API: the current records of a name, which names point at an IP or a range, which domains use a name server, mail host or SPF include, which TXT records contain a string, what lives under a domain, and which other domains share signals with a domain, mailbox or address. Authentication is a bearer API key. Every answer describes records ndxer has observed.

Start with the full guide: it explains authentication, units, limits, errors, pagination and every endpoint, with recipes. For the exact request and response types, use the OpenAPI document; where the two disagree, the OpenAPI document wins.

## Docs

- [Full guide for language models](https://ndxer.com/llms-full.txt): everything on one page, in Markdown
- [OpenAPI 3 document](https://api.ndxer.com/v1/openapi.json): the machine-readable contract; generate typed clients from it
- [API reference](https://ndxer.com/docs/api/): the same document, browsable
- [Quickstart](https://ndxer.com/docs/quickstart/): create a key and make a first request
- [Using ndxer with AI assistants](https://ndxer.com/docs/ai/): example prompts and how to keep a key out of a chat

## Account

- [API keys](https://ndxer.com/app/api-keys/): create and revoke keys (sign-in required). Read the key from the NDXER_API_KEY environment variable; never paste it into a chat
- [Pricing](https://ndxer.com/pricing/): plans and their limits

## Optional

- Base URL: https://api.ndxer.com/v1/
- Contact: contact@ndxer.com