apizoo.json 54 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037
  1. [
  2. {
  3. "user_name": "saikolasani",
  4. "api_name": "Gmail API - Users.getProfile",
  5. "api_call": "service.users().getProfile(userId='me').execute()",
  6. "api_version": "1.0",
  7. "api_arguments": {
  8. "userId" : "The user's email address. The special value 'me' can be used to indicate the authenticated user."
  9. },
  10. "functionality": "Gets the current user's Gmail profile.",
  11. "env_requirements": ["google-auth", "google-auth-oauthlib", "google-auth-httplib2", "google-api-python-client"],
  12. "example_code": "from googleapiclient.discovery import build \n from oauth2client import file, client, tools \n store = file.Storage('token.json') \n creds = store.get() \n service = build('gmail', 'v1', credentials=creds) \n results = service.users().getProfile(userId='me').execute()",
  13. "meta_data": {
  14. "description": "The Users.getProfile method of Gmail API allows for retrieving basic profile information of a user, such as the email address and account ID.",
  15. "documentation_link" : "https://developers.google.com/gmail/api/reference/rest/v1/users/getProfile"
  16. }
  17. },
  18. {
  19. "user_name": "saikolasani",
  20. "api_name": "Gmail API - Users.stop",
  21. "api_call": "service.users().stop(userId='me').execute()",
  22. "api_version": "1.0",
  23. "api_arguments": {
  24. "userId" : "The user's email address. The special value 'me' can be used to indicate the authenticated user."
  25. },
  26. "functionality": "User stops receiving push notifications for the given user mailbox.",
  27. "env_requirements": ["google-auth", "google-auth-oauthlib", "google-auth-httplib2", "google-api-python-client"],
  28. "example_code": "from googleapiclient.discovery import build \n from oauth2client import file, client, tools \n store = file.Storage('token.json') \n creds = store.get() \n service = build('gmail', 'v1', credentials=creds) \n results = service.users().getProfile(userId='me').execute()",
  29. "meta_data": {
  30. "description": "The Users.stop method stops any push notifications (set up via Gmail API's watch method) for the authenticated user's Gmail account.",
  31. "documentation_link" : "https://developers.google.com/gmail/api/reference/rest/v1/users/stop"
  32. }
  33. },
  34. {
  35. "user_name": "saikolasani",
  36. "api_name": "Gmail API - Users.watch",
  37. "api_call": "service.users().watch(userId='me').execute()",
  38. "api_version": "1.0",
  39. "api_arguments": {
  40. "userId" : "The user's email address. The special value 'me' can be used to indicate the authenticated user."
  41. },
  42. "functionality": "Set up or update a push notification watch on the given user mailbox."
  43. },
  44. {
  45. "user_name": "saikolasani",
  46. "api_name": "Gmail API - Users.drafts.create",
  47. "api_call": "service.users().drafts().create(userId='me', body='draft_body').execute()",
  48. "api_version": "1.0",
  49. "api_arguments": {
  50. "userId" : "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  51. "body": "The draft message body including the message content."
  52. },
  53. "functionality": "Create a new draft email in the authenticated user's Gmail account."
  54. },
  55. {
  56. "user_name": "saikolasani",
  57. "api_name": "Gmail API - Users.drafts.delete",
  58. "api_call": "service.users().drafts().delete(userId='me').execute()",
  59. "api_version": "1.0",
  60. "api_arguments": {
  61. "userId" : "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  62. "id": "The ID of the draft to be deleted."
  63. },
  64. "functionality": "Delete a specific draft email in the authenticated user's Gmail account."
  65. },
  66. {
  67. "user_name": "saikolasani",
  68. "api_name": "Gmail API - Users.drafts.get",
  69. "api_call": "service.users().drafts().get(userId='me').execute()",
  70. "api_version": "1.0",
  71. "api_arguments": {
  72. "userId" : "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  73. "id": "The ID of the draft to be deleted."
  74. },
  75. "functionality": "Retrieve a specific draft email in the authenticated user's Gmail account."
  76. },
  77. {
  78. "user_name": "saikolasani",
  79. "api_name": "Gmail API - Users.drafts.list",
  80. "api_call": "service.users().drafts().list(userId='me', spamTrash=True, q='is:unread').execute()",
  81. "api_version": "1.0",
  82. "api_arguments": {
  83. "userId" : "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  84. "spamTrash": "Boolean parameter to include drafts from spam and trash.",
  85. "q": "Query string to filter drafts, similar to Gmail search.",
  86. "maxResults": "Maximum number of drafts to return.",
  87. "pageToken": "Page token to retrieve a specific page of results."
  88. },
  89. "functionality": "Lists the drafts in the user's mailbox."
  90. },
  91. {
  92. "user_name": "saikolasani",
  93. "api_name": "Gmail API - Users.drafts.send",
  94. "api_call": "service.users().drafts().send(userId='me', body='draft_message').execute()",
  95. "api_version": "1.0",
  96. "api_arguments": {
  97. "userId" : "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  98. "body": "The draft message body including the message content."
  99. },
  100. "functionality": "Send an email from a draft in the authenticated user's Gmail account."
  101. },
  102. {
  103. "user_name": "saikolasani",
  104. "api_name": "Gmail API - Users.drafts.update",
  105. "api_call": "service.users().drafts().update(userId='me', body='draft_message').execute()",
  106. "api_version": "1.0",
  107. "api_arguments": {
  108. "userId" : "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  109. "id": "The ID of the draft to be updated.",
  110. "body": "The draft message body including the message content."
  111. },
  112. "functionality": "Update an existing draft in the authenticated user's Gmail account."
  113. },
  114. {
  115. "user_name": "saikolasani",
  116. "api_name": "Gmail API - Users.history.list",
  117. "api_call": "service.users().history().list(userId='me', startHistoryId='your_start_history_id').execute()",
  118. "api_version": "1.0",
  119. "api_arguments": {
  120. "userId" : "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  121. "startHistoryId": "History ID from which to start listing history records.",
  122. "labelId": "Only return history with changes to this label.",
  123. "maxResults": "Maximum number of history records to return.",
  124. "pageToken": "Page token to retrieve a specific page of results.",
  125. "historyTypes": "Types of history records to return (e.g., 'labelAdded', 'labelRemoved')."
  126. },
  127. "functionality": "Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId)."
  128. },
  129. {
  130. "user_name": "saikolasani",
  131. "api_name": "Gmail API - Users.labels.create",
  132. "api_call": "service.users().labels().create(userId='me', body=label_properties).execute()",
  133. "api_version": "1.0",
  134. "api_arguments": {
  135. "userId" : "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  136. "body": "The label properties, including name, visibility, etc."
  137. },
  138. "functionality": "Create a new label in the authenticated user's Gmail account."
  139. },
  140. {
  141. "user_name": "saikolasani",
  142. "api_name": "Gmail API - Users.labels.delete",
  143. "api_call": "service.users().labels().delete(userId='me', id='LABEL_ID').execute()",
  144. "api_version": "1.0",
  145. "api_arguments": {
  146. "userId" : "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  147. "id": "The ID of the label to be deleted."
  148. },
  149. "functionality": "Delete a specific label from the authenticated user's Gmail account."
  150. },
  151. {
  152. "user_name": "saikolasani",
  153. "api_name": "Gmail API - Users.labels.get",
  154. "api_call": "service.users().labels().get(userId='me', id='LABEL_ID').execute()",
  155. "api_version": "1.0",
  156. "api_arguments": {
  157. "userId" : "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  158. "id": "The ID of the label to be retrieved."
  159. },
  160. "functionality": "Retrieve a specific label from the authenticated user's Gmail account."
  161. },
  162. {
  163. "user_name": "saikolasani",
  164. "api_name": "Gmail API - Users.labels.list",
  165. "api_call": "service.users().labels().list(userId='me').execute()",
  166. "api_version": "1.0",
  167. "api_arguments": {
  168. "userId" : "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  169. "id": "The ID of the label to be retrieved."
  170. },
  171. "functionality": "Lists all labels in the user's mailbox."
  172. },
  173. {
  174. "user_name": "saikolasani",
  175. "api_name": "Gmail API - Users.labels.patch",
  176. "api_call": "service.users().labels().patch(userId='me', id='LABEL_ID', body=label_properties).execute()",
  177. "api_version": "1.0",
  178. "api_arguments": {
  179. "userId" : "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  180. "id": "The ID of the label to be patched.",
  181. "body": "The label properties, including name, visibility, etc."
  182. },
  183. "functionality": "Patch the specified label."
  184. },
  185. {
  186. "user_name": "saikolasani",
  187. "api_name": "Gmail API - Users.labels.update",
  188. "api_call": "service.users().labels().update(userId='me', id='LABEL_ID', body=label_properties).execute()",
  189. "api_version": "1.0",
  190. "api_arguments": {
  191. "userId" : "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  192. "id": "The ID of the label to be patched.",
  193. "body": "The label properties, including name, visibility, etc."
  194. },
  195. "functionality": "Updates the specified label."
  196. },
  197. {
  198. "user_name": "saikolasani",
  199. "api_name": "Gmail API - Users.messages.batchDelete",
  200. "api_call": "service.users().messages().batchDelete(userId='user_id', body={'ids': message_ids}).execute()",
  201. "api_version": "1.0",
  202. "api_arguments": {
  203. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  204. "body": {
  205. "ids": "A list of message IDs to delete. These should be the unique IDs of the messages."
  206. }
  207. },
  208. "functionality": "Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all."
  209. },
  210. {
  211. "user_name": "saikolasani",
  212. "api_name": "Gmail API - Users.messages.batchModify",
  213. "api_call": "service.users().messages().batchModify(userId='user_id', body=batch_modify_request_body).execute()",
  214. "api_version": "1.0",
  215. "api_arguments": {
  216. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  217. "body": {
  218. "ids": "A list of message IDs to modify. These should be the unique IDs of the messages.",
  219. "addLabelIds": "List of label IDs to add to the messages.",
  220. "removeLabelIds": "List of label IDs to remove from the messages."
  221. }
  222. },
  223. "functionality": "Modifies the labels on the specified messages."
  224. },
  225. {
  226. "user_name": "saikolasani",
  227. "api_name": "Gmail API - Users.messages.delete",
  228. "api_call": "service.users().messages().delete(userId='user_id', id='message_id').execute()",
  229. "api_version": "1.0",
  230. "api_arguments": {
  231. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  232. "id": "The ID of the message to delete."
  233. },
  234. "functionality": "Immediately and permanently deletes the specified message. This operation cannot be undone."
  235. },
  236. {
  237. "user_name": "saikolasani",
  238. "api_name": "Gmail API - Users.messages.get",
  239. "api_call": "service.users().messages().get(userId='user_id', id='message_id', format='full').execute()",
  240. "api_version": "1.0",
  241. "api_arguments": {
  242. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  243. "id": "The ID of the message to get.",
  244. "format": "The format to return the message in. Options include 'minimal', 'full', 'raw', and 'metadata'."
  245. },
  246. "functionality": "Gets the specified message."
  247. },
  248. {
  249. "user_name": "saikolasani",
  250. "api_name": "Gmail API - Users.messages.import",
  251. "api_call": "service.users().messages().import_(userId='user_id', body=message_body, internalDateSource='date_received').execute()",
  252. "api_version": "1.0",
  253. "api_arguments": {
  254. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  255. "body": "The raw RFC822 formatted message to import.",
  256. "internalDateSource": "Source of the internal date of the message. Options include 'date_received' and 'date_header'.",
  257. "deleted": "Boolean indicating if the message should be immediately marked as permanently deleted.",
  258. "processForCalendar": "Boolean indicating if the message should be processed for calendar invites.",
  259. "neverMarkedAsSpam": "Boolean indicating if the message should never be marked as spam."
  260. },
  261. "functionality": "Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP."
  262. },
  263. {
  264. "user_name": "saikolasani",
  265. "api_name": "Gmail API - Users.messages.insert",
  266. "api_call": "service.users().messages().insert(userId='user_id', body=message_body, internalDateSource='date_received').execute()",
  267. "api_version": "1.0",
  268. "api_arguments": {
  269. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  270. "body": "The raw RFC822 formatted message to insert.",
  271. "internalDateSource": "Source of the internal date of the message. Options include 'date_received' and 'date_header'.",
  272. "deleted": "Boolean indicating if the message should be immediately marked as permanently deleted."
  273. },
  274. "functionality": "Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message."
  275. },
  276. {
  277. "user_name": "saikolasani",
  278. "api_name": "Gmail API - Users.messages.list",
  279. "api_call": "service.users().messages().list(userId='user_id').execute()",
  280. "api_version": "1.0",
  281. "api_arguments": {
  282. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  283. "labelIds": "List of labels to filter by. Optional.",
  284. "q": "Query string to filter messages. Optional.",
  285. "pageToken": "Token for the page of results to retrieve. Optional.",
  286. "maxResults": "Maximum number of results to return. Optional."
  287. },
  288. "functionality": "Lists the messages in the user's mailbox."
  289. },
  290. {
  291. "user_name": "saikolasani",
  292. "api_name": "Gmail API - Users.messages.modify",
  293. "api_call": "service.users().messages().modify(userId='user_id', id='message_id', body={'addLabelIds': [label_ids_to_add], 'removeLabelIds': [label_ids_to_remove]}).execute()",
  294. "api_version": "1.0",
  295. "api_arguments": {
  296. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  297. "id": "The ID of the message to be modified.",
  298. "body": {
  299. "addLabelIds": "List of label IDs to add to the message.",
  300. "removeLabelIds": "List of label IDs to remove from the message."
  301. }
  302. },
  303. "functionality": "Modifies the labels on the specified message."
  304. },
  305. {
  306. "user_name": "saikolasani",
  307. "api_name": "Gmail API - Users.messages.send",
  308. "api_call": "service.users().messages().send(userId='user_id', body={'raw': raw_message}).execute()",
  309. "api_version": "1.0",
  310. "api_arguments": {
  311. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  312. "body": {
  313. "raw": "The entire email message in an RFC 2822 formatted and base64url encoded string."
  314. }
  315. },
  316. "functionality": "Sends the specified message to the recipients in the To, Cc, and Bcc headers."
  317. },
  318. {
  319. "user_name": "saikolasani",
  320. "api_name": "Gmail API - Users.messages.trash",
  321. "api_call": "service.users().messages().trash(userId='user_id', id='message_id').execute()",
  322. "api_version": "1.0",
  323. "api_arguments": {
  324. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  325. "id": "The ID of the message to be trashed."
  326. },
  327. "functionality": "Moves the specified message to the trash."
  328. },
  329. {
  330. "user_name": "saikolasani",
  331. "api_name": "Gmail API - Users.messages.untrash",
  332. "api_call": "service.users().messages().untrash(userId='user_id', id='message_id').execute()",
  333. "api_version": "1.0",
  334. "api_arguments": {
  335. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  336. "id": "The ID of the message to be untrashed."
  337. },
  338. "functionality": "Removes the specified message from the trash."
  339. },
  340. {
  341. "user_name": "saikolasani",
  342. "api_name": "Gmail API - Users.messages.attachments.get",
  343. "api_call": "service.users().messages().get(userId='user_id', messageId='message_id', id='attachment_id').execute()",
  344. "api_version": "1.0",
  345. "api_arguments": {
  346. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  347. "messageId": "The ID of the message containing the attachment.",
  348. "id": "The ID of the attachment to retrieve."
  349. },
  350. "functionality": "Gets the specified message attachment."
  351. },
  352. {
  353. "user_name": "saikolasani",
  354. "api_name": "Gmail API - Users.settings.getAutoForwarding",
  355. "api_call": "service.users().settings().getAutoForwarding(userId='user_id').execute()",
  356. "api_version": "1.0",
  357. "api_arguments": {
  358. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user."
  359. },
  360. "functionality": "Gets the auto-forwarding setting for the specified account."
  361. },
  362. {
  363. "user_name": "saikolasani",
  364. "api_name": "Gmail API - Users.settings.getLanguage",
  365. "api_call": "service.users().settings().getLanguage(userId='user_id').execute()",
  366. "api_version": "1.0",
  367. "api_arguments": {
  368. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user."
  369. },
  370. "functionality": "Gets language settings."
  371. },
  372. {
  373. "user_name": "saikolasani",
  374. "api_name": "Gmail API - Users.settings.getPop",
  375. "api_call": "service.users().settings().getPop(userId='user_id').execute()",
  376. "api_version": "1.0",
  377. "api_arguments": {
  378. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user."
  379. },
  380. "functionality": "Gets POP settings."
  381. },
  382. {
  383. "user_name": "saikolasani",
  384. "api_name": "Gmail API - Users.settings.getVacation",
  385. "api_call": "service.users().settings().getVacation(userId='user_id').execute()",
  386. "api_version": "1.0",
  387. "api_arguments": {
  388. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user."
  389. },
  390. "functionality": "Gets vacation responder settings."
  391. },
  392. {
  393. "user_name": "saikolasani",
  394. "api_name": "Gmail API - Users.settings.updateAutoForwarding",
  395. "api_call": "service.users().settings().updateAutoForwarding(userId='user_id', body={'enabled': boolean, 'emailAddress': 'forwarding_email_address', 'disposition': 'disposition_setting'}).execute()",
  396. "api_version": "1.0",
  397. "api_arguments": {
  398. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  399. "body": {
  400. "enabled": "Boolean indicating whether auto-forwarding is enabled or disabled.",
  401. "emailAddress": "The email address to which messages are forwarded.",
  402. "disposition": "The disposition of the messages which are auto-forwarded. Options are 'leaveInInbox', 'archive', 'trash', 'markRead', etc."
  403. }
  404. },
  405. "functionality": "Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled."
  406. },
  407. {
  408. "user_name": "saikolasani",
  409. "api_name": "Gmail API - Users.settings.updateImap",
  410. "api_call": "service.users().settings().updateImap(userId='user_id', body={'enabled': boolean, 'autoExpunge': boolean, 'expungeBehavior': 'expunge_behavior', 'maxFolderSize': integer}).execute()",
  411. "api_version": "1.0",
  412. "api_arguments": {
  413. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  414. "body": {
  415. "enabled": "Boolean indicating whether IMAP is enabled or disabled.",
  416. "autoExpunge": "Boolean indicating whether to immediately expunge messages when they are marked as deleted in IMAP.",
  417. "expungeBehavior": "Indicates the behavior of expunge. Options are 'archive', 'trash', or 'deleteForever'.",
  418. "maxFolderSize": "An integer indicating the maximum size of an IMAP folder."
  419. }
  420. },
  421. "functionality": "Updates IMAP settings."
  422. },
  423. {
  424. "user_name": "saikolasani",
  425. "api_name": "Gmail API - Users.settings.updateLanguage",
  426. "api_call": "service.users().settings().updateLanguage(userId='user_id', body={'languageCode': 'language_code'}).execute()",
  427. "api_version": "1.0",
  428. "api_arguments": {
  429. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  430. "body": {
  431. "languageCode": "The language code (as per ISO 639-1) for the new language setting."
  432. }
  433. },
  434. "functionality": "Updates language settings."
  435. },
  436. {
  437. "user_name": "saikolasani",
  438. "api_name": "Gmail API - Users.settings.updatePop",
  439. "api_call": "service.users().settings().updatePop(userId='user_id', body={'accessWindow': 'access_window', 'disposition': 'disposition_setting'}).execute()",
  440. "api_version": "1.0",
  441. "api_arguments": {
  442. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  443. "body": {
  444. "accessWindow": "The POP access window. Options include 'disabled', 'fromNowOn', 'allMail', etc.",
  445. "disposition": "The action to be taken on the message after it is accessed via POP. Options include 'leaveInInbox', 'archive', 'trash', etc."
  446. }
  447. },
  448. "functionality": "Updates POP settings."
  449. },
  450. {
  451. "user_name": "saikolasani",
  452. "api_name": "Gmail API - Users.settings.updateVacation",
  453. "api_call": "service.users().settings().updateVacation(userId='user_id', body={'enableAutoReply': boolean, 'responseSubject': 'subject_text', 'responseBodyPlainText': 'response_text', 'restrictToContacts': boolean, 'restrictToDomain': boolean, 'startTime': 'start_time', 'endTime': 'end_time'}).execute()",
  454. "api_version": "1.0",
  455. "api_arguments": {
  456. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  457. "body": {
  458. "enableAutoReply": "Boolean indicating whether the auto-responder is enabled.",
  459. "responseSubject": "Subject of the auto-reply message.",
  460. "responseBodyPlainText": "Plain text body of the auto-reply message.",
  461. "restrictToContacts": "Boolean indicating if the response is sent only to people in the user's contacts.",
  462. "restrictToDomain": "Boolean indicating if the response is sent only to people in the user's domain.",
  463. "startTime": "The start time for the auto-reply in milliseconds since epoch.",
  464. "endTime": "The end time for the auto-reply in milliseconds since epoch."
  465. }
  466. },
  467. "functionality": "Updates vacation responder settings."
  468. },
  469. {
  470. "user_name": "saikolasani",
  471. "api_name": "Gmail API - Users.settings.delegates.create",
  472. "api_call": "service.users().settings().delegates().create(userId='user_id', body={'delegateEmail': 'delegate_email'}).execute()",
  473. "api_version": "1.0",
  474. "api_arguments": {
  475. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  476. "body": {
  477. "delegateEmail": "The email address of the delegate to be added."
  478. }
  479. },
  480. "functionality": "Adds a delegate with its verification status set directly to accepted, without sending any verification email."
  481. },
  482. {
  483. "user_name": "saikolasani",
  484. "api_name": "Gmail API - Users.settings.delegates.delete",
  485. "api_call": "service.users().settings().delegates().delete(userId='user_id', delegateEmail='delegate_email').execute()",
  486. "api_version": "1.0",
  487. "api_arguments": {
  488. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  489. "delegateEmail": "The email address of the delegate to be removed."
  490. },
  491. "functionality": "Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it."
  492. },
  493. {
  494. "user_name": "saikolasani",
  495. "api_name": "Gmail API - Users.settings.delegates.get",
  496. "api_call": "service.users().settings().delegates().get(userId='user_id', delegateEmail='delegate_email').execute()",
  497. "api_version": "1.0",
  498. "api_arguments": {
  499. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  500. "delegateEmail": "The email address of the delegate to be removed."
  501. },
  502. "functionality": "Gets the specified delegate."
  503. },
  504. {
  505. "user_name": "saikolasani",
  506. "api_name": "Gmail API - Users.settings.delegates.list",
  507. "api_call": "service.users().settings().delegates().list(userId='user_id').execute()",
  508. "api_version": "1.0",
  509. "api_arguments": {
  510. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user."
  511. },
  512. "functionality": "Lists the delegates for the specified account."
  513. },
  514. {
  515. "user_name": "saikolasani",
  516. "api_name": "Gmail API - Users.settings.filters.create",
  517. "api_call": "service.users().settings().filters().create(userId='user_id', body={'criteria': {'from': 'example@gmail.com'}, 'action': {'addLabelIds': ['label_id']}}).execute()",
  518. "api_version": "1.0",
  519. "api_arguments": {
  520. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  521. "body": {
  522. "criteria": {
  523. "from": "Email address or criteria for the filter"
  524. },
  525. "action": {
  526. "addLabelIds": ["Label IDs to apply"]
  527. }
  528. }
  529. },
  530. "functionality": "Creates a filter. Note: you can only create a maximum of 1,000 filters."
  531. },
  532. {
  533. "user_name": "saikolasani",
  534. "api_name": "Gmail API - Users.settings.filters.delete",
  535. "api_call": "service.users().settings().filters().delete(userId='user_id', id='filter_id').execute()",
  536. "api_version": "1.0",
  537. "api_arguments": {
  538. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  539. "id": "The unique identifier of the email filter to be deleted."
  540. },
  541. "functionality": "mmediately and permanently deletes the specified filter."
  542. },
  543. {
  544. "user_name": "saikolasani",
  545. "api_name": "Gmail API - Users.settings.filters.get",
  546. "api_call": "service.users().settings().filters().get(userId='user_id', id='filter_id').execute()",
  547. "api_version": "1.0",
  548. "api_arguments": {
  549. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  550. "id": "The unique identifier of the email filter to be deleted."
  551. },
  552. "functionality": "Gets a filter."
  553. },
  554. {
  555. "user_name": "saikolasani",
  556. "api_name": "Gmail API - Users.settings.filters.list",
  557. "api_call": "service.users().settings().filters().list(userId='user_id').execute()",
  558. "api_version": "1.0",
  559. "api_arguments": {
  560. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user."
  561. },
  562. "functionality": "Lists the message filters of a Gmail user."
  563. },
  564. {
  565. "user_name": "saikolasani",
  566. "api_name": "Gmail API - Users.settings.forwardingAddresses.create",
  567. "api_call": "service.users().settings().forwardingAddresses().create(userId='user_id', body={'forwardingEmail': 'forward@example.com'}).execute()",
  568. "api_version": "1.0",
  569. "api_arguments": {
  570. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  571. "body": {
  572. "forwardingEmail": "The email address to which emails will be forwarded."
  573. }
  574. },
  575. "functionality": "Creates a forwarding address."
  576. },
  577. {
  578. "user_name": "saikolasani",
  579. "api_name": "Gmail API - Users.settings.forwardingAddresses.delete",
  580. "api_call": "service.users().settings().forwardingAddresses().delete(userId='user_id', forwardingEmail='forward@example.com').execute()",
  581. "api_version": "1.0",
  582. "api_arguments": {
  583. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  584. "forwardingEmail": "The email address of the forwarding address to be deleted."
  585. },
  586. "functionality": "Deletes the specified forwarding address and revokes any verification that may have been required."
  587. },
  588. {
  589. "user_name": "saikolasani",
  590. "api_name": "Gmail API - Users.settings.forwardingAddresses.get",
  591. "api_call": "service.users().settings().forwardingAddresses().get(userId='user_id', forwardingEmail='forward@example.com').execute()",
  592. "api_version": "1.0",
  593. "api_arguments": {
  594. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  595. "forwardingEmail": "The email address of the forwarding address to be deleted."
  596. },
  597. "functionality": "Gets the specified forwarding address."
  598. },
  599. {
  600. "user_name": "saikolasani",
  601. "api_name": "Gmail API - Users.settings.forwardingAddresses.list",
  602. "api_call": "service.users().settings().forwardingAddresses().get(userId='user_id').execute()",
  603. "api_version": "1.0",
  604. "api_arguments": {
  605. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user."
  606. },
  607. "functionality": "Lists the forwarding addresses."
  608. },
  609. {
  610. "user_name": "saikolasani",
  611. "api_name": "Gmail API - Users.settings.sendAs.create",
  612. "api_call": "service.users().settings().sendAs().create(userId='user_id', body={'sendAsEmail': 'alias@example.com', 'displayName': 'Alias Name', 'replyToAddress': 'reply@example.com', 'isPrimary': false, 'isDefault': false, 'treatAsAlias': false, 'smtpMsa': {'host': 'smtp.example.com', 'port': 587, 'username': 'smtp_user', 'password': 'smtp_password'}}).execute()",
  613. "api_version": "1.0",
  614. "api_arguments": {
  615. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  616. "body": {
  617. "sendAsEmail": "The email address to send messages as (alias email).",
  618. "displayName": "The display name for the alias.",
  619. "replyToAddress": "The email address to use as the reply-to address.",
  620. "isPrimary": "Whether this alias is the primary send-as alias.",
  621. "isDefault": "Whether this alias should be used as the default send-as alias.",
  622. "treatAsAlias": "Whether to treat this alias as an alias for external forwarding.",
  623. "smtpMsa": "SMTP configuration for the alias (host, port, username, password)."
  624. }
  625. },
  626. "functionality": "Creates a custom 'from' send-as alias."
  627. },
  628. {
  629. "user_name": "saikolasani",
  630. "api_name": "Gmail API - Users.settings.sendAs.delete",
  631. "api_call": "service.users().settings().sendAs().delete(userId='user_id', sendAsEmail='alias@example.com').execute()",
  632. "api_version": "1.0",
  633. "api_arguments": {
  634. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  635. "sendAsEmail": "The email address of the send-as alias to be deleted."
  636. },
  637. "functionality": "Deletes the specified send-as alias. Revokes any verification that may have been required for using it."
  638. },
  639. {
  640. "user_name": "saikolasani",
  641. "api_name": "Gmail API - Users.settings.sendAs.get",
  642. "api_call": "service.users().settings().sendAs().get(userId='user_id', sendAsEmail='alias@example.com').execute()",
  643. "api_version": "1.0",
  644. "api_arguments": {
  645. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  646. "sendAsEmail": "The email address of the send-as alias to be deleted."
  647. },
  648. "functionality": "Gets the specified send-as alias."
  649. },
  650. {
  651. "user_name": "saikolasani",
  652. "api_name": "Gmail API - Users.settings.sendAs.list",
  653. "api_call": "service.users().settings().sendAs().list(userId='user_id').execute()",
  654. "api_version": "1.0",
  655. "api_arguments": {
  656. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user."
  657. },
  658. "functionality": "Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom 'from' aliases."
  659. },
  660. {
  661. "user_name": "saikolasani",
  662. "api_name": "Gmail API - Users.settings.sendAs.patch",
  663. "api_call": "service.users().settings().sendAs().patch(userId='user_id', sendAsEmail='alias@example.com', body={'displayName': 'New Alias Name', 'replyToAddress': 'new_reply@example.com', 'isDefault': true}).execute()",
  664. "api_version": "1.0",
  665. "api_arguments": {
  666. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  667. "sendAsEmail": "The email address of the send-as alias to be updated.",
  668. "body": {
  669. "displayName": "The updated display name for the alias.",
  670. "replyToAddress": "The updated email address to use as the reply-to address.",
  671. "isPrimary": "Whether this alias should be set as the primary send-as alias.",
  672. "isDefault": "Whether this alias should be used as the default send-as alias.",
  673. "treatAsAlias": "Whether to treat this alias as an alias for external forwarding.",
  674. "smtpMsa": "SMTP configuration for the alias (host, port, username, password)."
  675. }
  676. },
  677. "functionality": "Patch the specified send-as alias."
  678. },
  679. {
  680. "user_name": "saikolasani",
  681. "api_name": "Gmail API - Users.settings.sendAs.update",
  682. "api_call": "service.users().settings().sendAs().update(userId='user_id', sendAsEmail='alias@example.com', body={'displayName': 'Updated Alias Name', 'replyToAddress': 'updated_reply@example.com', 'isPrimary': true, 'isDefault': true, 'treatAsAlias': false, 'smtpMsa': {'host': 'smtp.example.com', 'port': 587, 'username': 'smtp_user', 'password': 'smtp_password'}}).execute()",
  683. "api_version": "1.0",
  684. "api_arguments": {
  685. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  686. "sendAsEmail": "The email address of the send-as alias to be updated.",
  687. "body": {
  688. "displayName": "The updated display name for the alias.",
  689. "replyToAddress": "The updated email address to use as the reply-to address.",
  690. "isPrimary": "Whether this alias should be set as the primary send-as alias.",
  691. "isDefault": "Whether this alias should be used as the default send-as alias.",
  692. "treatAsAlias": "Whether to treat this alias as an alias for external forwarding.",
  693. "smtpMsa": "SMTP configuration for the alias (host, port, username, password)."
  694. }
  695. },
  696. "functionality": "Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias."
  697. },
  698. {
  699. "user_name": "saikolasani",
  700. "api_name": "Gmail API - Users.settings.sendAs.verify",
  701. "api_call": "service.users().settings().sendAs().verify(userId='user_id', sendAsEmail='alias@example.com').execute()",
  702. "api_version": "1.0",
  703. "api_arguments": {
  704. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  705. "sendAsEmail": "The email address of the send-as alias to be updated."
  706. },
  707. "functionality": "Sends a verification email to the specified send-as alias address. The verification status must be pending."
  708. },
  709. {
  710. "user_name": "saikolasani",
  711. "api_name": "Gmail API - Users.settings.sendAs.smimeInfo.delete",
  712. "api_call": "service.users().settings().sendAs().smimeInfo().delete(userId='user_id', sendAsEmail='alias@example.com', id='smime_info_id').execute()",
  713. "api_version": "1.0",
  714. "api_arguments": {
  715. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  716. "sendAsEmail": "The email address of the send-as alias to be updated.",
  717. "id": "The ID of the S/MIME information to be deleted."
  718. },
  719. "functionality": "Deletes the specified S/MIME config for the specified send-as alias."
  720. },
  721. {
  722. "user_name": "saikolasani",
  723. "api_name": "Gmail API - Users.settings.sendAs.smimeInfo.get",
  724. "api_call": "service.users().settings().sendAs().smimeInfo().get(userId='user_id', sendAsEmail='alias@example.com', id='smime_info_id').execute()",
  725. "api_version": "1.0",
  726. "api_arguments": {
  727. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  728. "sendAsEmail": "The email address of the send-as alias to be updated.",
  729. "id": "The ID of the S/MIME information to be deleted."
  730. },
  731. "functionality": "Gets the specified S/MIME config for the specified send-as alias."
  732. },
  733. {
  734. "user_name": "saikolasani",
  735. "api_name": "Gmail API - Users.settings.sendAs.smimeInfo.list",
  736. "api_call": "service.users().settings().sendAs().smimeInfo().list(userId='user_id', sendAsEmail='alias@example.com').execute()",
  737. "api_version": "1.0",
  738. "api_arguments": {
  739. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  740. "sendAsEmail": "The email address of the send-as alias to be updated."
  741. },
  742. "functionality": "Lists S/MIME configs for the specified send-as alias."
  743. },
  744. {
  745. "user_name": "saikolasani",
  746. "api_name": "Gmail API - Users.settings.sendAs.smimeInfo.insert",
  747. "api_call": "service.users().settings().sendAs().smimeInfo().insert(userId='user_id', sendAsEmail='alias@example.com', body={'defaultKeyId': 'key_id', 'issuerCn': 'issuer_common_name', 'isDefault': true, 'expiration': 'expiration_timestamp', 'encryptedKeyPassword': 'encrypted_key_password', 'key': {'pem': 'pem_certificate', 'pkcs12': 'pkcs12_data'}}).execute()",
  748. "api_version": "1.0",
  749. "api_arguments": {
  750. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  751. "sendAsEmail": "The email address of the send-as alias for which S/MIME info will be inserted.",
  752. "body": {
  753. "defaultKeyId": "The ID of the S/MIME key to use as the default.",
  754. "issuerCn": "The S/MIME certificate issuer's common name.",
  755. "isDefault": "Whether this SmimeInfo is the default one for this user's send-as address.",
  756. "expiration": "When the certificate expires (in milliseconds since epoch).",
  757. "encryptedKeyPassword": "Encrypted key password, when the key is encrypted.",
  758. "key": {
  759. "pem": "PEM formatted X509 concatenated certificate string (standard base64 encoding).",
  760. "pkcs12": "PKCS#12 format containing a single private/public key pair and certificate chain (base64-encoded)."
  761. }
  762. }
  763. },
  764. "functionality": "Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key."
  765. },
  766. {
  767. "user_name": "saikolasani",
  768. "api_name": "Gmail API - Users.settings.sendAs.smimeInfo.setDefault",
  769. "api_call": "service.users().settings().sendAs().smimeInfo().setDefault(userId='user_id', sendAsEmail='alias@example.com', id='smime_info_id').execute()",
  770. "api_version": "1.0",
  771. "api_arguments": {
  772. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  773. "sendAsEmail": "The email address of the send-as alias to be updated.",
  774. "id": "The ID of the S/MIME information to be deleted."
  775. },
  776. "functionality": "Sets the default S/MIME config for the specified send-as alias."
  777. },
  778. {
  779. "user_name": "saikolasani",
  780. "api_name": "Gmail API - Users.threads.delete",
  781. "api_call": "service.users().threads().delete(userId='user_id', id='thread_id').execute()",
  782. "api_version": "1.0",
  783. "api_arguments": {
  784. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  785. "id": "The ID of the thread to delete."
  786. },
  787. "functionality": "Immediately and permanently deletes the specified thread. Any messages that belong to the thread are also deleted. This operation cannot be undone."
  788. },
  789. {
  790. "user_name": "saikolasani",
  791. "api_name": "Gmail API - Users.threads.get",
  792. "api_call": "service.users().threads().get(userId='user_id', id='thread_id', format='desired_format', metadataHeaders=['header1', 'header2']).execute()",
  793. "api_version": "1.0",
  794. "api_arguments": {
  795. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  796. "id": "The ID of the thread to retrieve.",
  797. "format": "The format to return the messages in.",
  798. "metadataHeaders": "When given and format is METADATA, only include headers specified."
  799. },
  800. "functionality": "Gets the specified thread."
  801. },
  802. {
  803. "user_name": "saikolasani",
  804. "api_name": "Gmail API - Users.threads.list",
  805. "api_call": "service.users().threads().list(userId='user_id', q='query_string', maxResults=10, pageToken='page_token', labelIds=['label_id1', 'label_id2'], includeSpamTrash=true).execute()",
  806. "api_version": "1.0",
  807. "api_arguments": {
  808. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  809. "maxResults": "Maximum number of threads to return. Defaults to 100. Maximum allowed value is 500.",
  810. "pageToken": "Page token to retrieve a specific page of results in the list.",
  811. "q": "Query string to filter threads. Supports Gmail search box format.",
  812. "labelIds": "List of label IDs to filter threads by.",
  813. "includeSpamTrash": "Include threads from SPAM and TRASH in the results (true or false)."
  814. },
  815. "functionality": "Lists the threads in the user's mailbox."
  816. },
  817. {
  818. "user_name": "saikolasani",
  819. "api_name": "Gmail API - Users.threads.modify",
  820. "api_call": "service.users().threads().modify(userId='user_id', id='thread_id', body={'addLabelIds': ['label_id1', 'label_id2'], 'removeLabelIds': ['label_id3', 'label_id4']}).execute()",
  821. "api_version": "1.0",
  822. "api_arguments": {
  823. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  824. "id": "The ID of the thread to modify.",
  825. "body": {
  826. "addLabelIds": "List of label IDs to add to the thread.",
  827. "removeLabelIds": "List of label IDs to remove from the thread."
  828. }
  829. },
  830. "functionality": "Modifies the labels applied to the thread. This applies to all messages in the thread."
  831. },
  832. {
  833. "user_name": "saikolasani",
  834. "api_name": "Gmail API - Users.threads.trash",
  835. "api_call": "service.users().threads().trash(userId='user_id', id='thread_id').execute()",
  836. "api_version": "1.0",
  837. "api_arguments": {
  838. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  839. "id": "The ID of the thread to trash."
  840. },
  841. "functionality": "Moves the specified thread to the trash. Any messages that belong to the thread are also moved to the trash."
  842. },
  843. {
  844. "user_name": "saikolasani",
  845. "api_name": "Gmail API - Users.threads.untrash",
  846. "api_call": "service.users().threads().untrash(userId='user_id', id='thread_id').execute()",
  847. "api_version": "1.0",
  848. "api_arguments": {
  849. "userId": "The user's email address. The special value 'me' can be used to indicate the authenticated user.",
  850. "id": "The ID of the thread to untrash."
  851. },
  852. "functionality": "Removes the specified thread from the trash. Any messages that belong to the thread are also removed from the trash."
  853. },
  854. {
  855. "user_name": "raywanb",
  856. "api_name": "yfinance - Yahoo Finance Mass Download of Market Data API",
  857. "api_call": "yf.download({tickers}, start={start_date}, end={end_date}, group_by={group_by})",
  858. "api_version": "0.2.36",
  859. "api_arguments": {
  860. "tickers": "A list of stock tickers to download data for (separated by space)",
  861. "start_date": "Start date for data retrieval (format: 'YYYY-MM-DD')",
  862. "end_date": "End date for data retrieval (format: 'YYYY-MM-DD')",
  863. "group_by": "Optional parameter to group data by 'ticker' (default) or 'column' (group data by column names)"
  864. },
  865. "functionality": "Mass download historical market data for multiple stocks from Yahoo Finance",
  866. "env_requirements": ["Python library: yfinance"],
  867. "example_code": "import yfinance as yf \n\ntickers = 'SPY AAPL' \nstart_date = '2017-01-01' \nend_date = '2017-04-30' \ndata = yf.download(tickers, start=start_date, end=end_date, group_by='ticker')",
  868. "meta_data": {
  869. "description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. You can use it to mass download data for multiple stock tickers at once, specifying a start and end date. By default, data is grouped by ticker, but you can also choose to group it by column names."
  870. }
  871. },
  872. {
  873. "user_name": "raywanb",
  874. "api_name": "yfinance - Yahoo Finance Get History Metadata API",
  875. "api_call": "yfinance.Ticker({ticker}).history_metadata",
  876. "api_version": "0.2.36",
  877. "api_arguments": {
  878. "ticker": "Stock ticker to download data for"
  879. },
  880. "functionality": "Get historical meta data from Yahoo Finance",
  881. "env_requirements": ["Python library: yfinance"],
  882. "example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\n# get historical market data \nhist = msft.history(period='1mo') \nprint(msft.history_metadata)",
  883. "meta_data": {
  884. "description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It provides access to historical data with up to 1-minute granularity."
  885. }
  886. },
  887. {
  888. "user_name": "raywanb",
  889. "api_name": "yfinance - Yahoo Finance Dividends Data API",
  890. "api_call": "yfinance.Ticker({ticker}).dividends",
  891. "api_version": "0.2.36",
  892. "api_arguments": {
  893. "ticker": "Stock ticker to download data for"
  894. },
  895. "functionality": "Get historical meta data from Yahoo Finance",
  896. "env_requirements": ["Python library: yfinance"],
  897. "example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\nprint(msft.dividends)",
  898. "meta_data": {
  899. "description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It provides access to historical data with up to 1-minute granularity."
  900. }
  901. },
  902. {
  903. "user_name": "raywanb",
  904. "api_name": "yfinance - Yahoo Finance Splits Data API",
  905. "api_call": "yfinance.Ticker({ticker}).splits",
  906. "api_version": "0.2.36",
  907. "api_arguments": {
  908. "ticker": "Stock ticker to download data for"
  909. },
  910. "functionality": "Get historical meta data from Yahoo Finance",
  911. "env_requirements": ["Python library: yfinance"],
  912. "example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\nprint(msft.splits)",
  913. "meta_data": {
  914. "description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It provides access to historical data with up to 1-minute granularity."
  915. }
  916. },
  917. {
  918. "user_name": "raywanb",
  919. "api_name": "yfinance - Yahoo Finance News API",
  920. "api_call": "yfinance.Ticker({ticker}).news",
  921. "api_version": "0.2.36",
  922. "api_arguments": {
  923. "ticker": "Stock ticker to retrieve news for"
  924. },
  925. "functionality": "Get the latest news articles related to a stock from Yahoo Finance",
  926. "env_requirements": ["Python library: yfinance"],
  927. "example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\nprint(msft.news)",
  928. "meta_data": {
  929. "description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It also provides access to the latest news articles related to a specific stock."
  930. }
  931. },
  932. {
  933. "user_name": "raywanb",
  934. "api_name": "yfinance - Yahoo Finance Options API",
  935. "api_call": "yfinance.Ticker({ticker}).options",
  936. "api_version": "0.2.36",
  937. "api_arguments": {
  938. "ticker": "Stock ticker to retrieve options data for"
  939. },
  940. "functionality": "Get information on available options contracts for a specific stock from Yahoo Finance",
  941. "env_requirements": ["Python library: yfinance"],
  942. "example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\nprint(msft.options)",
  943. "meta_data": {
  944. "description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It also provides access to information on available options contracts for a specific stock."
  945. }
  946. },
  947. {
  948. "user_name": "raywanb",
  949. "api_name": "yfinance - Yahoo Finance Income Statement API",
  950. "api_call": "yfinance.Ticker({ticker}).financials",
  951. "api_version": "0.2.36",
  952. "api_arguments": {
  953. "ticker": "Stock ticker to retrieve income statement data for"
  954. },
  955. "functionality": "Get the income statement data for a specific stock from Yahoo Finance",
  956. "env_requirements": ["Python library: yfinance"],
  957. "example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\nprint(msft.financials)",
  958. "meta_data": {
  959. "description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It also provides access to income statement data for a specific stock."
  960. }
  961. },
  962. {
  963. "user_name": "raywanb",
  964. "api_name": "yfinance - Yahoo Finance Actions API",
  965. "api_call": "yfinance.Ticker({ticker}).actions",
  966. "api_version": "0.2.36",
  967. "api_arguments": {
  968. "ticker": "Stock ticker to retrieve actions data for"
  969. },
  970. "functionality": "Get the actions data (dividends, stock splits) for a specific stock from Yahoo Finance",
  971. "env_requirements": ["Python library: yfinance"],
  972. "example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\nprint(msft.actions)",
  973. "meta_data": {
  974. "description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It also provides access to actions data (like dividends and stock splits) for a specific stock."
  975. }
  976. },
  977. {
  978. "user_name": "raywanb",
  979. "api_name": "yfinance - Yahoo Finance Cash Flow API",
  980. "api_call": "yfinance.Ticker({ticker}).cashflow",
  981. "api_version": "0.2.36",
  982. "api_arguments": {
  983. "ticker": "Stock ticker to retrieve cash flow data for"
  984. },
  985. "functionality": "Get the cash flow data for a specific stock from Yahoo Finance",
  986. "env_requirements": ["Python library: yfinance"],
  987. "example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\nprint(msft.cashflow)",
  988. "meta_data": {
  989. "description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It also provides access to cash flow data for a specific stock."
  990. }
  991. },
  992. {
  993. "user_name": "raywanb",
  994. "api_name": "yfinance - Yahoo Finance Balance Sheet API",
  995. "api_call": "yfinance.Ticker({ticker}).balance_sheet",
  996. "api_version": "0.2.36",
  997. "api_arguments": {
  998. "ticker": "Stock ticker to retrieve balance sheet data for"
  999. },
  1000. "functionality": "Get the balance sheet data for a specific stock from Yahoo Finance",
  1001. "env_requirements": ["Python library: yfinance"],
  1002. "example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\nprint(msft.balance_sheet)",
  1003. "meta_data": {
  1004. "description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It also provides access to balance sheet data for a specific stock."
  1005. }
  1006. },
  1007. {
  1008. "user_name": "raywanb",
  1009. "api_name": "yfinance - Yahoo Finance Recommendations API",
  1010. "api_call": "yfinance.Ticker({ticker}).recommendations",
  1011. "api_version": "0.2.36",
  1012. "api_arguments": {
  1013. "ticker": "Stock ticker to retrieve analyst recommendations data for"
  1014. },
  1015. "functionality": "Get the analyst recommendations data for a specific stock from Yahoo Finance",
  1016. "env_requirements": ["Python library: yfinance"],
  1017. "example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\nprint(msft.recommendations)",
  1018. "meta_data": {
  1019. "description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It also provides access to analyst recommendations for a specific stock."
  1020. }
  1021. },
  1022. {
  1023. "user_name": "raywanb",
  1024. "api_name": "yfinance - Yahoo Finance Major Holders API",
  1025. "api_call": "yfinance.Ticker({ticker}).major_holders",
  1026. "api_version": "0.2.36",
  1027. "api_arguments": {
  1028. "ticker": "Stock ticker to retrieve major holders information for"
  1029. },
  1030. "functionality": "Get the major holders information for a specific stock from Yahoo Finance",
  1031. "env_requirements": ["Python library: yfinance"],
  1032. "example_code": "import yfinance as yf \n\nmsft = yf.Ticker('MSFT') \n\nprint(msft.major_holders)",
  1033. "meta_data": {
  1034. "description": "yfinance is a Python library that allows you to download historical market data from Yahoo Finance in a reliable and Pythonic way. It also provides access to major holders information for a specific stock."
  1035. }
  1036. }
  1037. ]