A client library implementing the full v1 REST API protocol for Mastodon in Guile
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

43 KiB

statuses Module


Table of Contents

  1. <mastodon-account>
  2. <mastodon-application>
  3. <mastodon-attachment>
  4. <mastodon-card>
  5. <mastodon-context>
  6. <mastodon-emoji>
  7. <mastodon-field>
  8. <mastodon-history>
  9. <mastodon-mention>
  10. <mastodon-meta-focus>
  11. <mastodon-meta-subtree>
  12. <mastodon-meta>
  13. <mastodon-pagination-object>
  14. <mastodon-poll>
  15. <mastodon-scheduled-status-params>
  16. <mastodon-scheduled-status>
  17. <mastodon-status>
  18. <mastodon-tag>
  19. masto-account-acct
  20. masto-account-avatar
  21. masto-account-avatar-static
  22. masto-account-bot?
  23. masto-account-created-at
  24. masto-account-discoverable?
  25. masto-account-display-name
  26. masto-account-emojis
  27. masto-account-fields
  28. masto-account-followers-count
  29. masto-account-following-count
  30. masto-account-group?
  31. masto-account-header
  32. masto-account-header-static
  33. masto-account-id
  34. masto-account-last-status-at
  35. masto-account-locked?
  36. masto-account-moved
  37. masto-account-note
  38. masto-account-statuses-count
  39. masto-account-url
  40. masto-account-username
  41. masto-account?
  42. masto-application-name
  43. masto-application-website
  44. masto-application?
  45. masto-attachment-blurhash
  46. masto-attachment-description
  47. masto-attachment-id
  48. masto-attachment-meta
  49. masto-attachment-preview-url
  50. masto-attachment-remote-url
  51. masto-attachment-text-url
  52. masto-attachment-type
  53. masto-attachment-url
  54. masto-attachment?
  55. masto-card-author-name
  56. masto-card-author-url
  57. masto-card-description
  58. masto-card-height
  59. masto-card-html
  60. masto-card-image
  61. masto-card-provider-name
  62. masto-card-provider-url
  63. masto-card-title
  64. masto-card-type
  65. masto-card-url
  66. masto-card-width
  67. masto-card?
  68. masto-context-ancestors
  69. masto-context-descendants
  70. masto-context?
  71. masto-emoji-shortcode
  72. masto-emoji-static-url
  73. masto-emoji-url
  74. masto-emoji-visible-in-picker?
  75. masto-emoji?
  76. masto-field-name
  77. masto-field-value
  78. masto-field-verified-at
  79. masto-field?
  80. masto-history-accounts
  81. masto-history-day
  82. masto-history-uses
  83. masto-history?
  84. masto-mention-acct
  85. masto-mention-id
  86. masto-mention-url
  87. masto-mention-username
  88. masto-mention?
  89. masto-meta-focus
  90. masto-meta-focus-x
  91. masto-meta-focus-y
  92. masto-meta-focus?
  93. masto-meta-original
  94. masto-meta-small
  95. masto-meta-subtree-aspect
  96. masto-meta-subtree-bitrate
  97. masto-meta-subtree-duration
  98. masto-meta-subtree-frame-rate
  99. masto-meta-subtree-height
  100. masto-meta-subtree-size
  101. masto-meta-subtree-width
  102. masto-meta-subtree?
  103. masto-meta?
  104. masto-page-next
  105. masto-page-objects
  106. masto-page-prev
  107. masto-page?
  108. masto-poll-expired
  109. masto-poll-expires-at
  110. masto-poll-id
  111. masto-poll-multiple
  112. masto-poll-options
  113. masto-poll-voted
  114. masto-poll-votes-count
  115. masto-poll?
  116. masto-scheduled-status-id
  117. masto-scheduled-status-media-attachments
  118. masto-scheduled-status-params
  119. masto-scheduled-status-params-application-id
  120. masto-scheduled-status-params-in-reply-to-id
  121. masto-scheduled-status-params-media-ids
  122. masto-scheduled-status-params-scheduled-at
  123. masto-scheduled-status-params-sensitive
  124. masto-scheduled-status-params-spoiler-text
  125. masto-scheduled-status-params-text
  126. masto-scheduled-status-params-visibility
  127. masto-scheduled-status-params?
  128. masto-scheduled-status-scheduled-at
  129. masto-scheduled-status?
  130. masto-tag-history
  131. masto-tag-name
  132. masto-tag-url
  133. masto-tag?
  134. masto-status-account
  135. masto-status-application
  136. masto-status-card
  137. masto-status-content
  138. masto-status-created-at
  139. masto-status-emojis
  140. masto-status-favorited
  141. masto-status-favorites-count
  142. masto-status-id
  143. masto-status-in-reply-to-account-id
  144. masto-status-in-reply-to-id
  145. masto-status-language
  146. masto-status-media-attachments
  147. masto-status-mentions
  148. masto-status-muted
  149. masto-status-pinned
  150. masto-status-poll
  151. masto-status-reblog-status
  152. masto-status-reblogged
  153. masto-status-reblogs-count
  154. masto-status-replies-count
  155. masto-status-sensitive
  156. masto-status-spoiler-text
  157. masto-status-tags
  158. masto-status-uri
  159. masto-status-url
  160. masto-status-visibility
  161. masto-status?
  162. masto-status-bookmark
  163. masto-status-create
  164. masto-status-delete
  165. masto-status-get
  166. masto-status-get-context
  167. masto-status-get-favorited-by
  168. masto-status-get-reblogged-by
  169. masto-status-pin
  170. masto-status-reblog
  171. masto-status-unbookmark
  172. masto-status-unpin
  173. masto-status-unreblog


<mastodon-account>

Summary

A record object that can be returned by an API call.

Record Fields

id
username
acct
displayName
locked
bot
discoverable
group
createdAt
followersCount
followingCount
statusesCount
lastStatusAt
note
url
avatar
avatarStatic
header
headerStatic
emojis
moved
fields


<mastodon-application>

Summary

A record object that can be returned by an API call.

Record Fields

name
website


<mastodon-attachment>

Summary

A record object that can be returned by an API call.

Record Fields

id
type
url
remoteURL
previewURL
textURL
meta
description
blurhash


<mastodon-card>

Summary

A record object that can be returned by an API call.

Record Fields

url
title
description
image
type
authorName
authorURL
providerName
providerURL
html
width
height


<mastodon-context>

Summary

A record object that can be returned by an API call.

Record Fields

ancestors
descendants


<mastodon-emoji>

Summary

A record object that can be returned by an API call.

Record Fields

shortcode
staticURL
url
visibleInPicker


<mastodon-field>

Summary

A record object that can be returned by an API call.

Record Fields

name
value
verifiedAt


<mastodon-history>

Summary

A record object that can be returned by an API call.

Record Fields

day
uses
accounts


<mastodon-mention>

Summary

A record object that can be returned by an API call.

Record Fields

url
username
acct
id


<mastodon-meta-focus>

Summary

A record object that can be returned by an API call.

Record Fields

x
y


<mastodon-meta-subtree>

Summary

A record object that can be returned by an API call.

Record Fields

width
height
size
aspect
frameRate
duration
bitrate


<mastodon-meta>

Summary

A record object that can be returned by an API call.

Record Fields

small
original
focus


<mastodon-pagination-object>

Summary

A record object that can be returned by an API call.

Record Fields

objectCollection
prevURL
prevPage
nextURL
nextPage
http-call
generate-fn


<mastodon-poll>

Summary

A record object that can be returned by an API call.

Record Fields

id
expiresAt
expired
multiple
votesCount
options
voted


<mastodon-scheduled-status-params>

Summary

A record object that can be returned by an API call.

Record Fields

text
inReplyToID
mediaIDs
sensitive
spoilerText
visibility
scheduledAt
applicationID


<mastodon-scheduled-status>

Summary

A record object that can be returned by an API call.

Record Fields

id
scheduledAt
params
mediaAttachments


<mastodon-status>

Summary

A record object that can be returned by an API call.

Record Fields

id
uri
url
account
inReplyToID
inReplyToAccountID
reblogStatus
content
createdAt
emojis
repliesCount
reblogsCount
favoritesCount
reblogged
favorited
muted
bookmarked
sensitive
spoilerText
visibility
mediaAttachments
mentions
tags
card
poll
application
language
pinned


<mastodon-tag>

Summary

A record object that can be returned by an API call.

Record Fields

name
url
history


masto-account-acct

Summary

#f

Parameters

#f03c15 s


masto-account-avatar

Summary

#f

Parameters

#f03c15 s


masto-account-avatar-static

Summary

#f

Parameters

#f03c15 s


masto-account-bot?

Summary

#f

Parameters

#f03c15 s


masto-account-created-at

Summary

#f

Parameters

#f03c15 s


masto-account-discoverable?

Summary

#f

Parameters

#f03c15 s


masto-account-display-name

Summary

#f

Parameters

#f03c15 s


masto-account-emojis

Summary

#f

Parameters

#f03c15 s


masto-account-fields

Summary

#f

Parameters

#f03c15 s


masto-account-followers-count

Summary

#f

Parameters

#f03c15 s


masto-account-following-count

Summary

#f

Parameters

#f03c15 s


masto-account-group?

Summary

#f

Parameters

#f03c15 s


masto-account-header

Summary

#f

Parameters

#f03c15 s


masto-account-header-static

Summary

#f

Parameters

#f03c15 s


masto-account-id

Summary

#f

Parameters

#f03c15 s


masto-account-last-status-at

Summary

#f

Parameters

#f03c15 s


masto-account-locked?

Summary

#f

Parameters

#f03c15 s


masto-account-moved

Summary

#f

Parameters

#f03c15 s


masto-account-note

Summary

#f

Parameters

#f03c15 s


masto-account-statuses-count

Summary

#f

Parameters

#f03c15 s


masto-account-url

Summary

#f

Parameters

#f03c15 s


masto-account-username

Summary

#f

Parameters

#f03c15 s


masto-account?

Summary

#f

Parameters

#f03c15 obj


masto-application-name

Summary

#f

Parameters

#f03c15 s


masto-application-website

Summary

#f

Parameters

#f03c15 s


masto-application?

Summary

#f

Parameters

#f03c15 obj


masto-attachment-blurhash

Summary

#f

Parameters

#f03c15 s


masto-attachment-description

Summary

#f

Parameters

#f03c15 s


masto-attachment-id

Summary

#f

Parameters

#f03c15 s


masto-attachment-meta

Summary

#f

Parameters

#f03c15 s


masto-attachment-preview-url

Summary

#f

Parameters

#f03c15 s


masto-attachment-remote-url

Summary

#f

Parameters

#f03c15 s


masto-attachment-text-url

Summary

#f

Parameters

#f03c15 s


masto-attachment-type

Summary

#f

Parameters

#f03c15 s


masto-attachment-url

Summary

#f

Parameters

#f03c15 s


masto-attachment?

Summary

#f

Parameters

#f03c15 obj


masto-card-author-name

Summary

#f

Parameters

#f03c15 s


masto-card-author-url

Summary

#f

Parameters

#f03c15 s


masto-card-description

Summary

#f

Parameters

#f03c15 s


masto-card-height

Summary

#f

Parameters

#f03c15 s


masto-card-html

Summary

#f

Parameters

#f03c15 s


masto-card-image

Summary

#f

Parameters

#f03c15 s


masto-card-provider-name

Summary

#f

Parameters

#f03c15 s


masto-card-provider-url

Summary

#f

Parameters

#f03c15 s


masto-card-title

Summary

#f

Parameters

#f03c15 s


masto-card-type

Summary

#f

Parameters

#f03c15 s


masto-card-url

Summary

#f

Parameters

#f03c15 s


masto-card-width

Summary

#f

Parameters

#f03c15 s


masto-card?

Summary

#f

Parameters

#f03c15 obj


masto-context-ancestors

Summary

#f

Parameters

#f03c15 s


masto-context-descendants

Summary

#f

Parameters

#f03c15 s


masto-context?

Summary

#f

Parameters

#f03c15 obj


masto-emoji-shortcode

Summary

#f

Parameters

#f03c15 s


masto-emoji-static-url

Summary

#f

Parameters

#f03c15 s


masto-emoji-url

Summary

#f

Parameters

#f03c15 s


masto-emoji-visible-in-picker?

Summary

#f

Parameters

#f03c15 s


masto-emoji?

Summary

#f

Parameters

#f03c15 obj


masto-field-name

Summary

#f

Parameters

#f03c15 s


masto-field-value

Summary

#f

Parameters

#f03c15 s


masto-field-verified-at

Summary

#f

Parameters

#f03c15 s


masto-field?

Summary

#f

Parameters

#f03c15 obj


masto-history-accounts

Summary

#f

Parameters

#f03c15 s


masto-history-day

Summary

#f

Parameters

#f03c15 s


masto-history-uses

Summary

#f

Parameters

#f03c15 s


masto-history?

Summary

#f

Parameters

#f03c15 obj


masto-mention-acct

Summary

#f

Parameters

#f03c15 s


masto-mention-id

Summary

#f

Parameters

#f03c15 s


masto-mention-url

Summary

#f

Parameters

#f03c15 s


masto-mention-username

Summary

#f

Parameters

#f03c15 s


masto-mention?

Summary

#f

Parameters

#f03c15 obj


masto-meta-focus

Summary

#f

Parameters

#f03c15 s


masto-meta-focus-x

Summary

#f

Parameters

#f03c15 s


masto-meta-focus-y

Summary

#f

Parameters

#f03c15 s


masto-meta-focus?

Summary

#f

Parameters

#f03c15 obj


masto-meta-original

Summary

#f

Parameters

#f03c15 s


masto-meta-small

Summary

#f

Parameters

#f03c15 s


masto-meta-subtree-aspect

Summary

#f

Parameters

#f03c15 s


masto-meta-subtree-bitrate

Summary

#f

Parameters

#f03c15 s


masto-meta-subtree-duration

Summary

#f

Parameters

#f03c15 s


masto-meta-subtree-frame-rate

Summary

#f

Parameters

#f03c15 s


masto-meta-subtree-height

Summary

#f

Parameters

#f03c15 s


masto-meta-subtree-size

Summary

#f

Parameters

#f03c15 s


masto-meta-subtree-width

Summary

#f

Parameters

#f03c15 s


masto-meta-subtree?

Summary

#f

Parameters

#f03c15 obj


masto-meta?

Summary

#f

Parameters

#f03c15 obj


masto-page-next

Summary

#f

Parameters

#f03c15 mastoApp
#f03c15 page


masto-page-objects

Summary

#f

Parameters

#f03c15 s


masto-page-prev

Summary

#f

Parameters

#f03c15 mastoApp
#f03c15 page


masto-page?

Summary

#f

Parameters

#f03c15 obj


masto-poll-expired

Summary

#f

Parameters

#f03c15 s


masto-poll-expires-at

Summary

#f

Parameters

#f03c15 s


masto-poll-id

Summary

#f

Parameters

#f03c15 s


masto-poll-multiple

Summary

#f

Parameters

#f03c15 s


masto-poll-options

Summary

#f

Parameters

#f03c15 s


masto-poll-voted

Summary

#f

Parameters

#f03c15 s


masto-poll-votes-count

Summary

#f

Parameters

#f03c15 s


masto-poll?

Summary

#f

Parameters

#f03c15 obj


masto-scheduled-status-id

Summary

#f

Parameters

#f03c15 s


masto-scheduled-status-media-attachments

Summary

#f

Parameters

#f03c15 s


masto-scheduled-status-params

Summary

#f

Parameters

#f03c15 s


masto-scheduled-status-params-application-id

Summary

#f

Parameters

#f03c15 s


masto-scheduled-status-params-in-reply-to-id

Summary

#f

Parameters

#f03c15 s


masto-scheduled-status-params-media-ids

Summary

#f

Parameters

#f03c15 s


masto-scheduled-status-params-scheduled-at

Summary

#f

Parameters

#f03c15 s


masto-scheduled-status-params-sensitive

Summary

#f

Parameters

#f03c15 s


masto-scheduled-status-params-spoiler-text

Summary

#f

Parameters

#f03c15 s


masto-scheduled-status-params-text

Summary

#f

Parameters

#f03c15 s


masto-scheduled-status-params-visibility

Summary

#f

Parameters

#f03c15 s


masto-scheduled-status-params?

Summary

#f

Parameters

#f03c15 obj


masto-scheduled-status-scheduled-at

Summary

#f

Parameters

#f03c15 s


masto-scheduled-status?

Summary

#f

Parameters

#f03c15 obj


masto-tag-history

Summary

#f

Parameters

#f03c15 s


masto-tag-name

Summary

#f

Parameters

#f03c15 s


masto-tag-url

Summary

#f

Parameters

#f03c15 s


masto-tag?

Summary

#f

Parameters

#f03c15 obj


masto-status-account

Summary

#f

Parameters

#f03c15 s


masto-status-application

Summary

#f

Parameters

#f03c15 s


masto-status-card

Summary

#f

Parameters

#f03c15 s


masto-status-content

Summary

#f

Parameters

#f03c15 s


masto-status-created-at

Summary

#f

Parameters

#f03c15 s


masto-status-emojis

Summary

#f

Parameters

#f03c15 s


masto-status-favorited

Summary

#f

Parameters

#f03c15 s


masto-status-favorites-count

Summary

#f

Parameters

#f03c15 s


masto-status-id

Summary

#f

Parameters

#f03c15 s


masto-status-in-reply-to-account-id

Summary

#f

Parameters

#f03c15 s


masto-status-in-reply-to-id

Summary

#f

Parameters

#f03c15 s


masto-status-language

Summary

#f

Parameters

#f03c15 s


masto-status-media-attachments

Summary

#f

Parameters

#f03c15 s


masto-status-mentions

Summary

#f

Parameters

#f03c15 s


masto-status-muted

Summary

#f

Parameters

#f03c15 s


masto-status-pinned

Summary

#f

Parameters

#f03c15 s


masto-status-poll

Summary

#f

Parameters

#f03c15 s


masto-status-reblog-status

Summary

#f

Parameters

#f03c15 s


masto-status-reblogged

Summary

#f

Parameters

#f03c15 s


masto-status-reblogs-count

Summary

#f

Parameters

#f03c15 s


masto-status-replies-count

Summary

#f

Parameters

#f03c15 s


masto-status-sensitive

Summary

#f

Parameters

#f03c15 s


masto-status-spoiler-text

Summary

#f

Parameters

#f03c15 s


masto-status-tags

Summary

#f

Parameters

#f03c15 s


masto-status-uri

Summary

#f

Parameters

#f03c15 s


masto-status-url

Summary

#f

Parameters

#f03c15 s


masto-status-visibility

Summary

#f

Parameters

#f03c15 s


masto-status?

Summary

#f

Parameters

#f03c15 obj


masto-status-bookmark

Summary

Bookmark the status, for the user tied to mastoApp, which has the ID statusID.

A <mastodon-status> is returned of the status which was bookmarked.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#f03c15 statusID


masto-status-create

Summary

Post a new status for the user tied to mastoApp.

For the status, a <mastodon-status> can be provided for #:statusObject; otherwise, #:statusText, #:inReplyToID, #:mediaIDs, #:sensitive, #:spoilerText, and #:visibility must be provided, instead. If #:statusObject is provided, the other parameters just listed will be ignored.

#:scheduledAt can be a SRFI-19 date object or a ISO 8601 Datetime string; if using a SRFI-19 date, the appropriately formatted string will be generated, for you.

<mastodon-poll> can be provided for #:poll; otherwise, #:pollOptions, #:pollExpiresIn, #:pollMultiple, and #:pollHideTotals must be provided, instead. If #:poll is provided, the other parameters just listed will be ignored.

#:idempotencyKey is used to prevent duplicate submissions of the same status. Idempotency keys are stored for up to 1 hour and can be any arbitrary string. Consider using a hash or UUID generated client-side.

A <mastodon-status> is returned; if #:scheduledAt is provided, a <mastodon-scheduled-status> is returned, instead.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#1589F0 #:statusObject (argument position 2)
#1589F0 #:statusText (argument position 3)
#1589F0 #:inReplyToID (argument position 4)
#1589F0 #:mediaIDs (argument position 5)
#1589F0 #:sensitive (argument position 6)
#1589F0 #:spoilerText (argument position 7)
#1589F0 #:visibility (argument position 8)
#1589F0 #:scheduledAt (argument position 9)
#1589F0 #:language (argument position 10)
#1589F0 #:poll (argument position 11)
#1589F0 #:pollOptions (argument position 12)
#1589F0 #:pollExpiresIn (argument position 13)
#1589F0 #:pollMultiple (argument position 14)
#1589F0 #:pollHideTotals (argument position 15)
#1589F0 #:idempotencyKey (argument position 16)


masto-status-delete

Summary

Delete the status for the user tied to mastoApp which has the ID statusID.

This function, if successful, returns #t.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#f03c15 statusID


masto-status-get

Summary

View an existing Fediverse status with the ID statusID.

domainOrApp can be the instance domain as a String or a <mastodon-instance-application>, whose associated domain will be used instead.

If the status in question is private, you will need to use a <mastodon-instance-application> for domainOrApp in order to determine if the user has permission to view the status.

A <mastodon-status> is returned.

Find the original documentation here.

Parameters

#f03c15 domainOrApp
#f03c15 statusID


masto-status-get-context

Summary

View the statuses above and below the status with the ID statusID.

domainOrApp can be the instance domain as a String or a <mastodon-instance-application>, whose associated domain will be used instead.

If the status in question is private, you will need to use a <mastodon-instance-application> for domainOrApp in order to determine if the user has permission to view the status.

A <mastodon-context> is returned.

Find the original documentation here.

Parameters

#f03c15 domainOrApp
#f03c15 statusID


masto-status-get-favorited-by

Summary

View who favorited the status that has the ID statusID.

domainOrApp can be the instance domain as a String or a <mastodon-instance-application>, whose associated domain will be used instead.

If the status in question is private, you will need to use a <mastodon-instance-application> for domainOrApp in order to determine if the user has permission to view the status.

A list of <mastodon-account>s is returned.

Find the original documentation here.

Parameters

#f03c15 domainOrApp
#f03c15 statusID


masto-status-get-reblogged-by

Summary

View who boosted the status that has the ID statusID.

domainOrApp can be the instance domain as a String or a <mastodon-instance-application>, whose associated domain will be used instead.

If the status in question is private, you will need to use a <mastodon-instance-application> for domainOrApp in order to determine if the user has permission to view the status.

A list of <mastodon-account>s is returned.

Find the original documentation here.

Parameters

#f03c15 domainOrApp
#f03c15 statusID


masto-status-pin

Summary

Pin the status, for the user tied to mastoApp, which has the ID statusID.

A <mastodon-status> is returned of the status which was pinned.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#f03c15 statusID


masto-status-reblog

Summary

Reblog the status, for the user tied to mastoApp, which has the ID statusID.

A <mastodon-status> is returned with the ID of the boosted status being retrievable via the [masto-status-reblog](#masto-status-reblog)-status function.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#f03c15 statusID


masto-status-unbookmark

Summary

Unbookmark the status, for the user tied to mastoApp, which has the ID statusID.

A <mastodon-status> is returned of the status which was unbookmarked.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#f03c15 statusID


masto-status-unpin

Summary

Unpin the status, for the user tied to mastoApp, which has the ID statusID.

A <mastodon-status> is returned of the status which was unpinned.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#f03c15 statusID


masto-status-unreblog

Summary

Unreblog the status, for the user tied to mastoApp, which has the ID statusID.

A <mastodon-status> is returned of the status which was unreblogged.

Find the original documentation here.

Parameters

#f03c15 mastoApp
#f03c15 statusID