URL (property)

This page documents an OPTIMADE Property Definition. See https://schemas.optimade.org/ for more information.

ID: https://schemas.optimade.org/defs/v1.2/properties/optimade/files/url
Definition name: url

Property name: URL
Description: The URL to get the contents of a file.
Type: string



Formats: [JSON] [MD]

JSON definition:

    "$id": "https://schemas.optimade.org/defs/v1.2/properties/optimade/files/url",
    "$schema": "https://schemas.optimade.org/meta/v1.2/optimade/property_definition.json",
    "title": "URL",
    "x-optimade-type": "string",
    "x-optimade-definition": {
        "label": "url_optimade_files",
        "kind": "property",
        "version": "1.2.0",
        "format": "1.2",
        "name": "url"
    "type": [
    "description": "The URL to get the contents of a file.\n\n**Requirements/Conventions:**\n\n- The URL MUST point to the actual contents of a file (i.e. byte stream), not an intermediate (preview) representation. For example, if referring to a file on GitHub, a link should point to raw contents.",
    "examples": [
    "x-optimade-unit": "inapplicable"