{
 "openapi": "3.0.3",
 "info": {
  "title": "Reachout API",
  "version": "1",
  "description": "Read-only recovery-meeting data from every fellowship (AA, NA, Al-Anon, SMART Recovery and about 25 more), worldwide, with a 0-5 secular score per meeting. Compiled by Reachout (https://reachout.kurtrasmussen.com) from public meeting lists. Please credit Reachout and the original lists, and send corrections to the original lists. Terms: Free to use. Credit Reachout and the original lists; send corrections to the original lists (each meeting's url). Don't present the data as your own or imply endorsement by any fellowship. Meeting details change; check the source before relying on them.",
  "termsOfService": "https://reachout.kurtrasmussen.com/api/v1/docs#terms",
  "contact": {
   "name": "Reachout (Kurt Rasmussen)",
   "url": "https://reachout.kurtrasmussen.com/about",
   "email": "info@kurtrasmussen.com"
  },
  "x-logo": {
   "url": "https://reachout.kurtrasmussen.com/icons/icon-512.png"
  }
 },
 "externalDocs": {
  "description": "API documentation",
  "url": "https://reachout.kurtrasmussen.com/api/v1/docs"
 },
 "tags": [
  {
   "name": "meetings"
  }
 ],
 "servers": [
  {
   "url": "https://reachout.kurtrasmussen.com/api/v1"
  }
 ],
 "components": {
  "securitySchemes": {
   "apiKey": {
    "type": "apiKey",
    "in": "header",
    "name": "X-Api-Key",
    "description": "Optional. Without a key: lower rate."
   }
  }
 },
 "security": [
  {},
  {
   "apiKey": []
  }
 ],
 "paths": {
  "/meetings/near": {
   "get": {
    "summary": "In-person and hybrid meetings near a point, nearest first.",
    "parameters": [
     {
      "name": "lat",
      "in": "query",
      "required": true,
      "description": "Latitude of the point.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "lng",
      "in": "query",
      "required": true,
      "description": "Longitude of the point.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "radius_km",
      "in": "query",
      "required": false,
      "description": "Search radius in kilometres (1-200). Default 40. Or use radius_miles (1-125).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "fellowship",
      "in": "query",
      "required": false,
      "description": "Fellowship code(s), comma-separated (AA, NA, AL-ANON, ...; see /fellowships). Default: all.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "day",
      "in": "query",
      "required": false,
      "description": "Weekday(s), comma-separated: 0 = Sunday ... 6 = Saturday. Default: all.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "attendance",
      "in": "query",
      "required": false,
      "description": "in_person and/or hybrid. Default: both.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "min_score",
      "in": "query",
      "required": false,
      "description": "Lowest secular score (0-5) to include. 3 = secular-friendly, 5 = listed as secular. Default 0.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "How many to return (1-500). Default 100.",
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK: { data, meta }"
     },
     "400": {
      "description": "Bad request"
     },
     "401": {
      "description": "Bad API key"
     },
     "404": {
      "description": "Not found"
     },
     "429": {
      "description": "Too many requests"
     }
    }
   }
  },
  "/meetings": {
   "get": {
    "summary": "Meetings in one country (and optionally one state or province), page by page.",
    "parameters": [
     {
      "name": "country",
      "in": "query",
      "required": true,
      "description": "Two-letter country code (US, CA, DE, ...).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "region",
      "in": "query",
      "required": false,
      "description": "State or province code within the country (MN, ON, ...). Default: the whole country.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "fellowship",
      "in": "query",
      "required": false,
      "description": "Fellowship code(s), comma-separated (AA, NA, AL-ANON, ...; see /fellowships). Default: all.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "day",
      "in": "query",
      "required": false,
      "description": "Weekday(s), comma-separated: 0 = Sunday ... 6 = Saturday. Default: all.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "attendance",
      "in": "query",
      "required": false,
      "description": "in_person, hybrid and/or online, comma-separated. Default: all.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "min_score",
      "in": "query",
      "required": false,
      "description": "Lowest secular score (0-5) to include. 3 = secular-friendly, 5 = listed as secular. Default 0.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "How many to return (1-1000). Default 500.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "cursor",
      "in": "query",
      "required": false,
      "description": "For the next page: the meta.next_cursor of the previous answer.",
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK: { data, meta }"
     },
     "400": {
      "description": "Bad request"
     },
     "401": {
      "description": "Bad API key"
     },
     "404": {
      "description": "Not found"
     },
     "429": {
      "description": "Too many requests"
     }
    }
   }
  },
  "/meetings/{id}": {
   "get": {
    "summary": "One meeting by its Reachout id (reachout_id). A copy listed by a second source returns the preferred copy.",
    "parameters": [
     {
      "name": "id",
      "in": "path",
      "required": true,
      "description": "The meeting's reachout_id.",
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK: { data, meta }"
     },
     "400": {
      "description": "Bad request"
     },
     "401": {
      "description": "Bad API key"
     },
     "404": {
      "description": "Not found"
     },
     "429": {
      "description": "Too many requests"
     }
    }
   }
  },
  "/online": {
   "get": {
    "summary": "Online meetings (and hybrid ones, which can be joined online), page by page.",
    "parameters": [
     {
      "name": "fellowship",
      "in": "query",
      "required": false,
      "description": "Fellowship code(s), comma-separated (AA, NA, AL-ANON, ...; see /fellowships). Default: all.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "day",
      "in": "query",
      "required": false,
      "description": "Weekday(s), comma-separated: 0 = Sunday ... 6 = Saturday. Default: all.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "include_hybrid",
      "in": "query",
      "required": false,
      "description": "1 to include hybrid meetings. Default 1.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "min_score",
      "in": "query",
      "required": false,
      "description": "Lowest secular score (0-5) to include. 3 = secular-friendly, 5 = listed as secular. Default 0.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "limit",
      "in": "query",
      "required": false,
      "description": "How many to return (1-1000). Default 500.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "cursor",
      "in": "query",
      "required": false,
      "description": "For the next page: the meta.next_cursor of the previous answer.",
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK: { data, meta }"
     },
     "400": {
      "description": "Bad request"
     },
     "401": {
      "description": "Bad API key"
     },
     "404": {
      "description": "Not found"
     },
     "429": {
      "description": "Too many requests"
     }
    }
   }
  },
  "/download": {
   "get": {
    "summary": "The whole data set as one zip, rebuilt weekly: README.txt, meetings.json (the same meeting shape as this API) and CSV tables of meetings, places, groups, clubhouses, fellowships and sources. About 50 MB. Needs an API key; at most 5 downloads a day per key.",
    "parameters": [
     {
      "name": "api_key",
      "in": "query",
      "required": false,
      "description": "Your key (or send it as the X-Api-Key header). Required here.",
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK: { data, meta }"
     },
     "400": {
      "description": "Bad request"
     },
     "401": {
      "description": "Bad API key"
     },
     "404": {
      "description": "Not found"
     },
     "429": {
      "description": "Too many requests"
     }
    }
   }
  },
  "/fellowships": {
   "get": {
    "summary": "The fellowship codes Reachout uses, with names and websites.",
    "parameters": [],
    "responses": {
     "200": {
      "description": "OK: { data, meta }"
     },
     "400": {
      "description": "Bad request"
     },
     "401": {
      "description": "Bad API key"
     },
     "404": {
      "description": "Not found"
     },
     "429": {
      "description": "Too many requests"
     }
    }
   }
  },
  "/sources": {
   "get": {
    "summary": "The public lists Reachout reads, with links and when each was last read.",
    "parameters": [
     {
      "name": "fellowship",
      "in": "query",
      "required": false,
      "description": "Fellowship code(s), comma-separated (AA, NA, AL-ANON, ...; see /fellowships). Default: all.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "country",
      "in": "query",
      "required": false,
      "description": "Two-letter country code. Default: all.",
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "OK: { data, meta }"
     },
     "400": {
      "description": "Bad request"
     },
     "401": {
      "description": "Bad API key"
     },
     "404": {
      "description": "Not found"
     },
     "429": {
      "description": "Too many requests"
     }
    }
   }
  }
 }
}