Sign in
Ganjoor

get poem by id

get/api/ganjoor/poem/{id}

Path parameters

idinteger required

Query parameters

catInfoboolean
catPoemsboolean
rhymesboolean
recitationsboolean
imagesboolean
songsboolean
commentsboolean

not implemented yet

verseDetailsboolean
navigationboolean

next/previous

relatedpoemsboolean
commentSortOrder0 | 1 | 2

how to sort a poem's comments

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

Changed in 3 of the 8 revisions of this API.16

  • 92410ac76ec11See the full diff
    • ○

      added the optional property verses/items/originalText to the response with the 200 status

      response-optional-property-added

  • 270df5ce50a011See the full diff
    • ●

      deleted the query request parameter sortByRanking

      request-parameter-removed

    • ○

      added the new optional query request parameter commentSortOrder

      new-optional-request-parameter

  • 585ae188c2554See the full diff
    • ○

      added the new optional query request parameter sortByRanking

      new-optional-request-parameter

    • ○

      added the optional property comments/items/currentUserRatingValue to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property comments/items/dislikeCount to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property comments/items/likeCount to the response with the 200 status

      response-optional-property-added