Developers and AI systems

Reading Proudli data

Last updated: 11 October 2026

Every public Proudli profile, case study and knowledge post can be read as clean Markdown, and profiles are also available as JSON. This page explains the formats, what the data means and how to use it. It is written for developers and for AI systems reading on a person's behalf.

At a glance

Access: Read-only. No API key or sign-up.
Formats: Markdown and JSON
What is included: Only what the public page already shows: personal details, agency, career history, years of experience, the Proudli score, the number of confirmed vouches, case studies and knowledge posts.
What is never included: Email addresses, phone numbers, the names or words of people who vouched, unpublished content, and street addresses the professional chose to hide.
Rate limit: 60 requests per 60 seconds per IP address
OpenAPI specification: https://api.proudli.com.au/v1/openapi.json
Index for AI systems: https://proudli.com.au/llms.txt

Markdown versions of pages

Add .md to the URL of any public profile, case study or knowledge post to get the same content as Markdown. Each page also advertises its Markdown version with a <link rel="alternate" type="text/markdown"> tag.

Profile: https://proudli.com.au/pro/{slug}.md
Case study: https://proudli.com.au/pro/{slug}/case-studies/{case-study}.md
Knowledge post: https://proudli.com.au/pro/{slug}/posts/{post}.md

AI visibility check reports are private to the agent who requested them and are not available through the Markdown or JSON endpoints. A profile's Markdown lists its key facts, career history and recent case studies and posts, each linked to its own full Markdown version. Every document ends with its source URL and the date it last changed.

JSON API

All endpoints are GET, return JSON and can be called from a browser on any origin. A full description of every field is in the OpenAPI specification.

Profile: https://api.proudli.com.au/v1/profiles/{slug}
All case studies: https://api.proudli.com.au/v1/profiles/{slug}/case-studies?page=1
All knowledge posts: https://api.proudli.com.au/v1/profiles/{slug}/posts?page=1

Example

curl https://api.proudli.com.au/v1/profiles/jane-citizen

A shortened response:

{
  "apiVersion": "v1",
  "data": {
    "slug": "jane-citizen",
    "url": "https://proudli.com.au/pro/jane-citizen",
    "markdownUrl": "https://proudli.com.au/pro/jane-citizen.md",
    "name": "Jane Citizen",
    "headline": "Inner-west sales agent",
    "profession": { "key": "real-estate.sales-agent", "label": "Sales agent" },
    "yearsExperience": 15,
    "serviceAreas": ["Newtown", "Enmore"],
    "agency": {
      "name": "Citizen Realty Newtown",
      "brandName": "Citizen Realty",
      "title": "Senior Sales Agent",
      "since": "2020-02-01T00:00:00.000Z"
    },
    "metrics": {
      "proudliScore": 312,
      "confirmedVouches": 7,
      "publishedCaseStudies": 4,
      "publishedPosts": 2
    },
    "caseStudies": { "total": 4, "items": [{ "headline": "…", "outcome": "…" }] },
    "posts": { "total": 2, "items": [{ "title": "…", "excerpt": "…" }] }
  }
}

Errors and limits

An unknown or unpublished profile returns 404. A renamed profile returns 308 with the new address. Going over the rate limit returns 429; wait and retry. Errors have the shape { "apiVersion": "v1", "error": { "code", "message" } }.

Versioning

Fields may be added to v1. Existing fields are not renamed or removed within a version.

Finding profiles

Profiles are read one at a time by slug: the last part of a profile URL, such as jane-citizen in https://proudli.com.au/pro/jane-citizen. There is no search or list endpoint. The sitemap lists every published profile, case study and knowledge post.

What the data means

Case studies

A case study (a Proof Story) is the professional's own account of a completed job. Its facts, including any sale price, are reported by the professional. Proudli does not independently check every fact.

Confirmed vouches

A vouch is counted only after the client or colleague who gave it confirmed it themselves, from the email address or phone number they were invited on. The count says how many people confirmed the professional's work. It is not a rating.

Proudli score

Points earned from published case studies, confirmed vouches, knowledge posts and other activity. Recent work counts for more than old work, and there is no fixed maximum, so it is not a mark out of 100. It is empty when the score is not shown publicly. Verification methodology

Using the data

Link to the profile or case study page when you quote or summarise it.
Describe case study facts as reported by the professional, not as independently verified.
Fetch fresh rather than keeping long-lived copies. Professionals can edit or unpublish their content, and removed content stops being served within 5 minutes.
Do not collect profiles in bulk or use the data to contact people.

Questions, or a correction to report? Contact Proudli. For company facts and terminology, see the official information page.