Skip to content

Latest commit

 

History

History
163 lines (119 loc) · 4.1 KB

README.md

File metadata and controls

163 lines (119 loc) · 4.1 KB
Raw

🏳️‍🌈 Pride Flag API

GitHub Repo Browse the Flags

This is an API to list data about various LGBTQA+ Pride Flags, delivered as JSON by REST or GraphQL. This isn't an exhaustive list, it's just ones I've added for now. If there are any missing let me know or open a Pull Request 😄

Using the API

Feel free to use this API for demos and fun things, I'd avoid using it for anything important 😅.

GraphQL

Primarily this is meant to be a GraphQL API. You can send GraphQL queries from your GraphQL Client to the following endpoint:

https://pride-flag.dev/api/graphql

You can view the schema and play with some queries at the GraphQL Playground.

Example Query:

query {
  flag(id: "transgender_1999") {
    id
    name
    year
    colors{
      name
      r
      g
      b
    }
    svgBase64
  }
}

Example Response:

{
  "data": {
    "flag": {
      "id": "transgender_1999",
      "name": "Transgender",
      "year": "1999",
      "colors": [
        {
          "name": "light blue",
          "r": 91,
          "g": 206,
          "b": 250
        },
        {
          "name": "pink",
          "r": 245,
          "g": 169,
          "b": 184
        },
        {
          "name": "white",
          "r": 255,
          "g": 255,
          "b": 255
        }
      ],
      "svgBase64": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA4MDAgNDgwIj48cGF0aCBmaWxsPSIjNUJDRUZBIiBkPSJNMCAwaDgwMHY0ODBIMHoiPjwvcGF0aD48cGF0aCBmaWxsPSIjRjVBOUI4IiBkPSJNMCA5Nmg4MDB2Mjg4SDB6Ij48L3BhdGg+PHBhdGggZmlsbD0iI0ZGRiIgZD0iTTAgMTkyaDgwMHY5NkgweiI+PC9wYXRoPjwvc3ZnPg=="
    }
  }
}

REST API

Fetch a Flag:

https://pride-flag.dev/api/flags/${id}

This will return the JSON object of the flag specified.

Example Request:

https://pride-flag.dev/api/flags/transgender_1999

Example Response:

{
  "name": "Transgender",
  "id": "transgender_1999",
  "year": "1999",
  "emoji": "🏳️‍⚧️",
  "colors": [
    { "name": "light blue", "hexCode": "#5BCEFA", "r": 91, "g": 206, "b": 250 },
    { "name": "pink", "hexCode": "#F5A9B8", "r": 245, "g": 169, "b": 184 },
    { "name": "white", "hexCode": "#FFF", "r": 255, "g": 255, "b": 255 }
  ],
  "svg": "<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 800 480\"><path fill=\"#5BCEFA\" d=\"M0 0h800v480H0z\"></path><path fill=\"#F5A9B8\" d=\"M0 96h800v288H0z\"></path><path fill=\"#FFF\" d=\"M0 192h800v96H0z\"></path></svg>"
}

Fetch a Flag's SVG

https://pride-flag.dev/api/flags/${id}/SVG

This will return the SVG of the flag specified.

Example Request:

https://pride.dev/api/flags/transgender_1999/SVG

Example Response:

<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 800 480"><path fill="#5BCEFA" d="M0 0h800v480H0z"></path><path fill="#F5A9B8" d="M0 96h800v288H0z"></path><path fill="#FFF" d="M0 192h800v96H0z"></path></svg>

Fetch all flags

https://pride-flag.dev/api/flags

This will return all flags specified.

Search flags

https://pride-flag.dev/api/flags?search=trans

This will return all flags where the name contains that search term.

Why have you built this?

I started this in Pride Month 2020, trapped inside due to Corona and thought I'd celebrate Pride by making an API instead of going to the parade.

And I also wanted a fun API to use in side-projects/talks/workshops.

Plus I noticed the domain pride.dev was still available and thought it was just too cool not to do something with it.

Who are you?

Hi I'm Joe Hart 👋. You can find me on twitter and tell me what you think, request features or flags.

Contributing

Checkout our contributing guidelines.

What's that cool font you're using on pride.dev?

It's called Gilbert and it's super cool, you can read more about is on the font's website.