Streamdata.io API Gallery - Open Science Framework (Report Issue)

Organization(s):

Open Science Framework Actions

A log can have one of many actions. The complete list of loggable actions (in the format {identifier}: {description}) is as follows: * `project_created`: A Node is created * `project_registered`: A Node is registered * `project_deleted`: A Node is...

Open Science Framework List all addons

A paginated list of addons configurable with the OSF #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of up to 10 addons. Each resource in the array is a separate addon object. The `links` k...

Open Science Framework List all citation styles

A paginated list of all standard citation styles available for rendering citations. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of 10 citation styles. Each resource in the array is a sep...

Open Science Framework Retrieve a citation style

Retrieves the details of a citation style. #### Returns Returns a JSON object with a `data` key containing the representation of the requested citation style, if the request is successful. If the request is unsuccessful, an `errors` key containin...

Open Science Framework Delete a comment

Deletes a comment. This action can be undone by setting deleted to False in a comment update request. #### Returns If the request is successful, no content is returned. If the request is unsuccessful, a JSON object with an `errors` key containing...

Open Science Framework Retrieve a comment

Retrieves the details of a comment ####Returns Returns a JSON object with a `data` key containing the representation of the requested comment, if the request was successful. If the request is unsuccessful, an `errors` key containing information a...

Open Science Framework Update a comment

Updates the specified comment by setting the values of the parameters passed. Any parameters not provided will be left unchanged. #### Returns Returns JSON with a `data` key containing the new representation of the updated comment, if the request ...

Open Science Framework Retrieve a file

Retrieves the details of a file (or folder) ####Returns Returns a JSON object with a `data` key containing the representation of the requested file, if the request was successful. If the request is unsuccessful, an `errors` key containing informa...

Open Science Framework Update a file

Updates the specified file by setting the values of the parameters passed. Any parameters not provided will be left unchanged. #### Returns Returns JSON with a `data` key containing the new representation of the updated file, if the request is suc...

Open Science Framework List all file versions

A paginated list of all file versions. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of 10 file versions. Each resource in the array is a separate file version object. The `links` key con...

Open Science Framework Retrieve a file version

Retrieves the details of a file version ####Returns Returns a JSON object with a `data` key containing the representation of the requested file, if the request was successful. If the request is unsuccessful, an `errors` key containing informatio...

Open Science Framework Root

Welcome to the Open Science Framework API. With this API you can access users, projects, components, logs, and files from the [Open Science Framework](https://osf.io/). The Open Science Framework (OSF) is a free, open-source service maintained by ...

Open Science Framework List all institutions

A paginated list of all verified institutions. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of 10 institutions. Each resource in the array is a separate institution object. The `links` k...

Open Science Framework Retrieve an institution

Retrieves the details of an institution ####Returns Returns a JSON object with a `data` key containing the representation of the requested institution, if the request was successful. If the request is unsuccessful, an `errors` key containing info...

Open Science Framework List all affiliated nodes

A paginated list of all nodes affiliated with an institution. #### Versioning As of version `2.2`, affiliated components (in addition to affiliated top-level projects) are returned from this endpoint. #### Returns Returns a JSON object containing ...

Open Science Framework List all affiliated registrations

A paginated list of all registrations affiliated with an institution. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of 10 registrations. Each resource in the array is a separate users obje...

Open Science Framework List all affiliated users

A paginated list of all users affiliated with an institution. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of 10 users. Each resource in the array is a separate users object. The `links`...

Open Science Framework Retrieve a license

Retrieves the details of a license. #### Returns Returns a JSON object with a `data` key containing the representation of the requested license, if the request is successful. If the request is unsuccessful, an `errors` key containing information ...

Open Science Framework List all licenses

A paginated list of licenses. The returned licenses are sorted by their name. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of 10 licenses. Each resource in the array is a separate license ...

Open Science Framework Retrieve a log

Retrieves the details of a log. A log is permanent immutable record of a node's history. A log is created when a user performs one of many actions. See the [actions](#Logs_logs_actions) section for more details. ####Returns Returns a JSON object w...

Open Science Framework List all metaschemas

A paginated list of all active metaschemas. Metaschemas describe the supplemental questions that accompany a registration. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of 10 metaschemas. ...

Open Science Framework Retrieve a metaschema

Retrieves the details of a given metaschema. Metaschemas describe the supplemental questions that accompany a registration. #### Returns Returns a JSON object with a `data` key containing the representation of the requested metaschema, if the re...

Open Science Framework List all nodes

A paginated list of nodes, representing projects and components, on the OSF. The returned nodes are those which are public or which the user has access to view. The returned nodes are sorted by their `date_modified`, with the most recently updat...

Open Science Framework Create a node

Creates a new node. On the OSF, nodes are considered **projects** or **components**. The difference between a project and a component is that a project is a top-level node, and a component is a child of a project. Additionally, nodes have a `cat...

Open Science Framework Delete a node

Permanently deletes a node. This action cannot be undone. #### Permissions Only project administrators may delete a node. Attempting to delete a node for which you are not an administrator will result in a **403 Forbidden** response. #### Returns ...

Open Science Framework Retrieve a node

Retrieves the details of a given node (project or component). #### Permissions Only project contributors may retrieve the details of a private node. Attempting to retreive a private node for which you are not a contributor will result in a **403 F...

Open Science Framework Update a node

Updates a node by setting the values of the attributes specified in the request body. Any unspecified attributes will be left unchanged. Nodes can be updated with either a **PUT** or **PATCH** request. The `title` and `category` fields are mandat...

Open Science Framework List all addons

A paginated list of addons connected to the given node or project. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of at most 10 addon objects. Each resource in the array is a separate addon...

Open Science Framework Retrieve an addon

Retrieve details of an individual addon connected to this node. #### Permissions NodeSettings that are attached to public nodes will give read-only access to everyone. Private nodes require explicit read permission. Write and admin access are the ...

Open Science Framework Update an addon

Updates a node addon by setting the values of the attributes specified in the request body. Any unspecified attributes will be left unchanged. Node addon can be updated with either a **PUT** or **PATCH** request. The `external_account_id`, `enabl...

Open Science Framework List all addon folders

A paginated list of folders retrieved from the associated third-party (provider) service. #### Permissions Folders are visible only to the user that authorized the addon. #### Returns Returns a JSON object containing `data` and `links` keys. The ...

Open Science Framework List all child nodes

A paginated list of the next level child nodes for the given node. The returned nodes are sorted by their `date_modified`, with the most recently updated child nodes appearing first. The list will include child nodes that are public, as well as c...

Open Science Framework Create a child node

Creates a new child node. Note: Creating a child node via this endpoint will function the same as creating a node via the node list endpoint, but the child node will have the given node set as its parent. #### Permissions Only write contributors ...

Open Science Framework Retrieve citation details

The citation details for a node, in CSL format. #### Returns Returns a JSON object with a `data` key that contains the representation of the details necessary for the node citation.

Open Science Framework Retrieve a styled citation

The citation for a node in a specific style. #### Returns Returns a JSON object with a `data` key that contains the representation of the node citation, in the requested style.

Open Science Framework List all comments

A paginated list of comments related to a given node. The returned comments are sorted by their creation date, with the most recent comments appearing first. ####Permissions Comments on public nodes are given read-only access to everyone. If the...

Open Science Framework Create a comment

Create a comment on a given node overview page or a reply to a comment on that node. To create a comment on the node overview page, the target `type` would be "nodes" and the target `id` would be the node `id`. To reply to a comment on this node...

Open Science Framework List all contributors

A paginated list of the node's contributors, sorted by their index. Contributors are users who can make changes to the node or, in the case of private nodes, have read access to the node. Contributors are categorized as either "bibliographic" or...

Open Science Framework Create a contributor

Adds a contributor to a node, effectively creating a relationship between the node and a user. Contributors are users who can make changes to the node or, in the case of private nodes, have read access to the node. Contributors are categorized a...

Open Science Framework Delete a contributor

Removes a contributor from a node. This request only removes the relationship between the node and the user, it does not delete the user itself. A node must always have at least one admin, and attempting to remove the only admin from a node will ...

Open Science Framework Retrieve a contributor

Retrieves the details of a given contributor. Contributors are users who can make changes to the node or, in the case of private nodes, have read access to the node. Contributors are categorized as either "bibliographic" or "non-bibliographic". ...

Open Science Framework Update a contributor

Updates a contributor by setting the values of the attributes specified in the request body. Any unspecified attributes will be left unchanged. Contributors can be updated with either a **PUT** or **PATCH** request. Since this endpoint has no man...

Open Science Framework List all draft registrations

A paginated list of all of the draft registrations of a given node. Draft registrations contain the supplemental registration questions that accompany a registration. A registration is a frozen version of the project that can never be edited or d...

Open Science Framework Create a draft registration

Initiate a draft registration of the current node. Draft registrations contain the supplemental registration questions that accompany a registration. A registration is a frozen version of the project that can never be edited or deleted, but can be...

Open Science Framework Delete a draft registration

Permanently deletes a draft registration. A draft that has already been registered cannot be deleted. #### Permissions Only project administrators may delete draft registrations. #### Returns If the request is successful, no content is returned. ...

Open Science Framework Retrieve a draft registration

Retrieve the details of a given draft registration. Draft registrations contain the supplemental registration questions that accompany a registration. A registration is a frozen version of the project that can never be edited or deleted, but can b...

Open Science Framework Update a draft registration

Updates a draft registration by setting the values of the attributes specified in the request body. Any unspecified attributes will be left unchanged. Draft registrations contain the supplemental registration questions that accompany a registrati...

Open Science Framework List all storage providers

List of all storage providers that are configured for this node Users of the OSF may access their data on a [number of cloud-storage services](https://api.osf.io/v2/#storage-providers) that have integrations with the OSF. We call these **provider...

Open Science Framework List all node files

List of all the files/folders that are attached to your project for a given storage provider. ####Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of files. Each resource in the array is a separat...

Open Science Framework Retrieve a file

Retrieves the details of a file attached to given node (project or component) for the given storage provider. ####Returns Returns a JSON object with a `data` key containing the representation of the requested file object, if the request is success...

Open Science Framework Retrieve a storage provider

Retrieves the details of a storage provider enabled on this node. ####Returns Returns a JSON object with a `data` key containing the representation of the requested file object, if the request is successful. If the request is unsuccessful, an `er...

Open Science Framework List all forks of this node

A paginated list of the current node's forks. The returned fork nodes are sorted by their `forked_date`, with the most recently forked nodes appearing first. Forking a project creates a copy of an existing node and all of its contents. The fork a...

Open Science Framework Create a fork of this node

Creates a fork of the given node. Forking a project creates a copy of an existing node and all of its contents. The fork always points back to the original node, forming a network of nodes. You might use a fork to copy another's work to build on...

Open Science Framework List all identifiers

List all identifiers associated with a given node. ####Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of identifiers. Each resource in the array is a separate identifier object. The `links` key...

Open Science Framework List all institutions

List of all institutions affiliated with this node. ####Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of up to 10 affilited institutions. Each resource in the array is a separate institution ob...

Open Science Framework List all linked nodes

List of all nodes linked to the given node. ####Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of up to 10 nodes. Each resource in the array is a separate node object. The `links` key contains ...

Open Science Framework List all logs

A paginated list of all logs associated with a given node. The returned logs are sorted by their `date`, with the most recents logs appearing first. This list includes the logs of the specified node as well as the logs of that node's children to...

Open Science Framework List all preprints

A paginated list of preprints related to a given node. The returned preprints are sorted by their creation date, with the most recent preprints appearing first. **Note: This API endpoint is under active development, and is subject to change in th...

Open Science Framework List all registrations

List of all registrations of the given node. ####Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of up to 10 registrations. Each resource in the array is a separate registrations object. The `l...

Open Science Framework List all view only links

List of view only links on a node. ####Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of up to 10 view only links. Each resource in the array is a view only link object. The `links` key contain...

Open Science Framework Retrieve a view only link

Retrieves the details of a view only link on a node. ####Returns Returns a JSON object with a `data` key containing the representation of the requested view only link, if the request is successful. If the request is unsuccessful, an `errors` key ...

Open Science Framework List all wikis

List of wiki pages on a node. ####Returns Paginated list of the node's current wiki page versions ordered by their date_modified. Each resource contains the full representation of the wiki, meaning additional requests to an individual wiki's detai...

Open Science Framework List all preprint providers

A paginated list of all preprint providers. The returned preprint providers are sorted by their creation date, with the most recent preprints appearing first. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key c...

Open Science Framework Retrieve a preprint provider

Retrieves the details of a preprint provider. #### Returns Returns a JSON object with a `data` key containing the representation of the requested preprint provider, if the request is successful. If the request is unsuccessful, an `errors` key con...

Open Science Framework List all licenses

A paginated list of the licenses allowed bya preprint provider. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of 10 preprint providers. Each resource in the array is a separate preprint pr...

Open Science Framework List all preprints

A paginated list of preprints from the specified preprint provider. The returned preprints are sorted by their creation date, with the most recent preprints appearing first. #### Returns Returns a JSON object containing `data` and `links` keys. T...

Open Science Framework List all taxonomies

A paginated list of the taxonomies for a preprint provider. The returned preprint providers taxonomies are sorted by their creation date, with the most recent preprints appearing first. #### Returns Returns a JSON object containing `data` and `lin...

Open Science Framework List all preprints

A paginated list of preprints from all preprint providers. The returned preprints are sorted by their creation date, with the most recent preprints appearing first. #### Returns Returns a JSON object containing `data` and `links` keys. The `data`...

Open Science Framework Create a preprint

Creates a new preprint. #### Returns Returns a JSON object with a `data` key containing the representation of the created preprint, if the request is successful. If the request is unsuccessful, an `errors` key containing information about the fai...

Open Science Framework Retrieve a preprint

Retrieves the details of a preprint. #### Returns Returns a JSON object with a `data` key containing the representation of the requested preprint, if the request is successful. If the request is unsuccessful, an `errors` key containing informatio...

Open Science Framework Update a preprint

Updates the specified preprint by setting the values of the parameters passed. Any parameters not provided will be left unchanged. #### Returns Returns a JSON object with a `data` key containing the new representation of the updated preprint, if t...

Open Science Framework Retrieve citation details

The citation details for a preprint, in CSL format. #### Returns Returns a JSON object with a `data` key that contains the representation of the details necessary for the preprint citation.

Open Science Framework Retrieve a styled citation

The citation for a preprint in a specific style. #### Returns Returns a JSON object with a `data` key that contains the representation of the preprint citation, in the requested style.

Open Science Framework List all registrations

A paginated list of registrations on the OSF to which the user has access. The returned registrations are those which are public or which the user has access to view. Non-registered nodes cannot be accessed through this endpoint (use the [nodes]...

Open Science Framework Retrieve a registration

Retrieve the details of a given registration. #### Permissions Only project contributors may retrieve the details of a registration that is embargoed, or has not yet been made public. Attempting to retrieve a private registration for which you are...

Open Science Framework Update a registration

Updates a registration's privacy from **private** to **public**. Registrations can be updated with either a **PUT** or **PATCH** request. The `public` field is the only field that can be modified on a registration Registrations can only be turne...

Open Science Framework List all child registrations

A paginated list of children of a registration. The list consists of the next level child registrations for the given registration. The returned registrations are sorted by their `date_modified`, with the most recently updated child registrations...

Open Science Framework List all citation styles

A paginated list of the registration's alternative citation styles #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of up to 10 citation styles. Each resource in the array is a separate cita...

Open Science Framework Retrieve a citation

Retrieves the citation style details for a registration, in CSL format. #### Returns Returns a JSON object with a `data` key that contains the representation of the details necessary for the citation style.

Open Science Framework List all comments

A paginated list of the registration's comments. The returned comments are sorted by their creation date, with the most recent comments appearing first. ####Permissions Comments of public registrations are given read-only access to everyone. If ...

Open Science Framework List all contributors

A paginated list of all contributors on this registration. The returned contributors are sorted by their index. Contributors are users who can make changes to the registration or, in the case of private registration, have read access to the regis...

Open Science Framework Retrieve a contributor

Retrieves the details of a contributor on this registration. #### Returns Returns a JSON object with a `data` key containing the representation of the requested contributor, if the request is successful. If the request is unsuccessful, an `error...

Open Science Framework List all storage providers

A paginated list of storage providers enabled on the registration Users of the OSF may access their data on a [number of cloud-storage services](https://api.osf.io/v2/#storage-providers) that have integrations with the OSF. We call these **provid...

Open Science Framework List all files

List of all the registration's files/folders for a given storage provider. ####Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of files. Each resource in the array is a separate file object and...

Open Science Framework Retrieve a file

Retrieves the details of a registration file for the given storage provider. ####Returns Returns a JSON object with a `data` key containing the representation of the requested registration file object, if the request is successful. If the request...

Open Science Framework List all forks

A paginated list of the registration’s forks The returned forks are sorted by their `forked_date`, with the most recent forks appearing first. Forking a registration creates a copy of an existing registration and all of its contents. #### Return...

Open Science Framework Create a fork

Creates a fork of the given registration. Forking a project creates a copy of an existing registration and all of its contents. The fork always points back to the original registration, forming a network of registrations. You might use a fork to...

Open Science Framework List all identifiers

A paginated list of the registration's identifiers. ####Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of identifiers. Each resource in the array is a separate identifier object. The `links` ke...

Open Science Framework List all institutions

A paginated list of institutions affiliated with the registration. ####Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of up to 10 affiliated institutions. Each resource in the array is a separat...

Open Science Framework List all linked nodes

List of all nodes linked to the registration. ####Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of up to 10 nodes. Each resource in the array is a separate node object. The `links` key contain...

Open Science Framework List all logs

A paginated list of the registration's logs. The returned logs are sorted by their `date`, with the most recents logs appearing first. ####Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of up ...

Open Science Framework List all view only links

A paginated list of view only links created for this registration. ####Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of up to 10 view only links. Each resource in the array is a view only link ...

Open Science Framework Retrieve a view only link

Retrieves the details of a view only link created from this registration. ####Returns Returns a JSON object with a `data` key containing the representation of the requested view only link, if the request is successful. If the request is unsuccess...

Open Science Framework List all wikis

A paginated list of the registration's wiki pages ####Returns A list of all registration's current wiki page versions ordered by their date_modified. Each resource contains the full representation of the wiki, meaning additional requests to an ind...

Open Science Framework List all taxonomies

A paginated list of all [bepress disciplines taxonomies](https://www.bepress.com/wp-content/uploads/2016/12/Digital-Commons-Disciplines-taxonomy-2017-01.pdf). Note: this API endpoint is under active development, and is subject to change in the fut...

Open Science Framework Retrieve a taxonomy

Retrieves the details of a taxonomy. #### Returns Returns a JSON object with a `data` key containing the representation of the requested taxonomy, if the request is successful. If the request is unsuccessful, an `errors` key containing informati...

Open Science Framework List all users

A paginated list of all users registered on the OSF. The returned users are sorted by their `date_registered`, with the most recently registered users appearing first. The subroute `/users/me/` is a special endpoint that always points to the curr...

Open Science Framework Retrieve a user

Retrieves the details of a given users. The returned information includes the user's bibliographic information and the date the user was registered. Additionally, relationships to the list of institutions with which the user is affiliated, and t...

Open Science Framework Update a user

Updates a user by setting the values of the attributes specified in the request body. Any unspecified attributes will be left unchanged. Users can be updated with either a **PUT** or **PATCH** request. The `full_name` field is mandatory in a **PU...

Open Science Framework List all user addons

A paginated list of authorized user addons #### Permissions User addons are visible only to the user that authorized the addon. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of up to 10...

Open Science Framework Retrieve a user addon

Retrieves the details of an authorized user addon #### Permissions User addons are visible only to the user that authorized the addon. ####Returns Returns a JSON object with a `data` key containing the representation of the requested user addon...

Open Science Framework List all addon accounts

A paginated list of addon accounts authorized by this user. #### Permissions Addon accounts are visible only to the user that authorized the account. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contain...

Open Science Framework Retrieve an addon account

Retrieves the details of an addon account #### Permissions Addon accounts are visible only to the user that authorized the account. ####Returns Returns a JSON object with a `data` key containing the representation of the requested addon account...

Open Science Framework List all institutions

A paginated list of institutions that the user is affiliated with. #### Returns Returns a JSON object containing `data` and `links` keys. The `data` key contains an array of 10 institutions. Each resource in the array is a complete institution ob...

Open Science Framework List all nodes

A paginated list of nodes that the user is a contributor to. The returned nodes are sorted by their `date_modified`, with the most recently updated nodes appearing first. If the user ID in the path is the same as the logged-in user, all nodes wil...

Open Science Framework List all preprints

A paginated list of preprints that the user contributes to. The returned preprints are sorted by their creation date, with the most recent preprints appearing first. #### Returns Returns a JSON object containing `data` and `links` keys. The `data...

Open Science Framework List all registrations

A paginated list of registrations that the user is a contributor to. The returned registrations are sorted by their `date_modified`, with the most recently updated registrations appearing first. If the user ID in the path is the same as the logge...

Open Science Framework Retrieve a view only link

Retrieves details about a specific view only link. ####Permissions Only project administrators may retrieve the details of a view only link. Attempting to retrieve a view only link without appropriate permissions will result in a 403 Forbidden res...

Open Science Framework List all nodes

The list of nodes which this view only link gives read-only access to. #### Permissions Only project administrators may retrieve the nodes of a view only link. Attempting to retrieve a view only link without appropriate permissions will result in ...

Open Science Framework Retrieve a Wiki

Retrieves the details about a specific wiki. A wiki is a collection of markdown text pages that can be used to describe the project or dataset of contained in the attached node. ####Returns Returns a JSON object with a `data` key containing the re...

Open Science Framework Retrieve the Content of a Wiki

Retrieves the plaintext content of a wiki in markdown format. ####Returns Returns `text/markdown` of the wiki content itself. If the request is unsuccessful, plaintext with the error message will be displayed.

Submit Your API

Join the gallery to find out how much you can save with Streamdata.io.