Find a word

GET

/api/word

curl --request GET \
  --url 'https://example.com/api/word?w=example'

• Same origin as the web app (the gateway routes /api/*).

Occurrences of one Gurmukhi word.

Parameters

Query Parameters

w

required

string

The word.

Responses

200

OK

Media typeapplication/json

object

word

required

string

count

required

integer

lines

required

Array<object>

object

id

required

integer

ang

required

integer

raag

required

Any of:

null

null

string

string

section

required

Any of:

null

null

string

string

author

required

string

comp_type

required

Any of:

null

null

string

string

comp_id

required

integer

line_no

required

integer

is_rahao

required

integer

is_header

required

integer

gurmukhi

required

string

translit

required

string

stanza_index

required

integer

pada_total

required

integer

source_category

required

string

Example^generated

{
  "word": "example",
  "count": 1,
  "lines": [
    {
      "id": 1,
      "ang": 1,
      "raag": "example",
      "section": "example",
      "author": "example",
      "comp_type": "example",
      "comp_id": 1,
      "line_no": 1,
      "is_rahao": 1,
      "is_header": 1,
      "gurmukhi": "example",
      "translit": "example",
      "stanza_index": 1,
      "pada_total": 1,
      "source_category": "example"
    }
  ]
}

400

Invalid request (bad or out-of-range parameter).

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}

500

Internal error (generic body; details are logged, never returned).

Media typeapplication/json

object

error

required

string

Example^generated

{
  "error": "example"
}