GAganjoor
Ganjoor

Get Similar Poems accroding to prosody and rhyme informations

Changed on
get/api/ganjoor/poems/similar

Request

  • Base URL
    https://api.ganjoor.net (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Query parameters

PageNumberinteger

page number starting from 1

PageSizeinteger

settable page size (-1 == all items, 1000 maxpagesize)

metrestring

cannot be empty

rhymestring

can be empty

poetIdinteger

send 0 for all

catIdinteger

send 0 for all

languagestring
format0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 10 | 11 | 16 | 32 | 40 | 45 | 64 | 128 | 176 | 187 | 256 | 512 | 992 | 1024 | 2032 | 2048

poem format

termstring
coupletCountsFrominteger
coupletCountsTointeger
einteger[]

Response

OK

idinteger

Id

titlestring nullable

title

fullTitlestring nullable

cat + parent cats title + title

urlSlugstring nullable

url => slug

fullUrlstring nullable

sample: /hafez/ghazal/sh1

plainTextstring nullable

verses text

htmlTextstring nullable

verses text as html (ganjoor.net format)

sourceNamestring nullable

source name

sourceUrlSlugstring nullable

source url slug

oldTagstring nullable

old collection or book name for Saadi's ghazalyiat (طیبات، خواتیم و ....)

oldTagPageUrlstring nullable

old collection page url e.g /saadi/tayyebat

mixedModeOrderinteger

order when mixed with categories

publishedboolean

published

languagestring nullable

language

poemSummarystring nullable

poem summary

sectionIndexinteger nullable

section index

claimedByMultiplePoetsboolean

poem is claimed by multiple poets

coupletsCountinteger nullable

couplets count

Changes

  • 143b912b1085Revision changes
    • info

      added the optional property /// to the response with the status

  • 330e7bb195c1Revision changes
    • info

      added the optional property //// to the response with the status