---
title: "Get SurfacePropDoc documents"
method: GET
path: "/materials/surface_properties/"
tags: ["Materials Surface Properties"]
---

# Get SurfacePropDoc documents

`GET /materials/surface_properties/`

## Query parameters

- `material_ids` string, nullable — Comma-separated list of material_id values to query on
- `weighted_surface_energy_EV_PER_ANG2_max` number, nullable — Query for maximum value of weighted_surface_energy_EV_PER_ANG2
- `weighted_surface_energy_EV_PER_ANG2_min` number, nullable — Query for minimum value of weighted_surface_energy_EV_PER_ANG2
- `weighted_surface_energy_max` number, nullable — Query for maximum value of weighted_surface_energy
- `weighted_surface_energy_min` number, nullable — Query for minimum value of weighted_surface_energy
- `surface_anisotropy_max` number, nullable — Query for maximum value of surface_anisotropy
- `surface_anisotropy_min` number, nullable — Query for minimum value of surface_anisotropy
- `shape_factor_max` number, nullable — Query for maximum value of shape_factor
- `shape_factor_min` number, nullable — Query for minimum value of shape_factor
- `weighted_work_function_max` number, nullable — Query for maximum value of weighted_work_function
- `weighted_work_function_min` number, nullable — Query for minimum value of weighted_work_function
- `has_reconstructed` boolean, nullable — Whether an entry or material has a reconstructed surface.
- `_page` integer — Page number to request (takes precedent over _limit and _skip).
- `_per_page` integer — Number of entries to show per page (takes precedent over _limit and _skip). Limited to 1000.
- `_skip` integer — Number of entries to skip in the search.
- `_limit` integer — Max number of entries to return in a single query. Limited to 1000.
- `_fields` string — Fields to project from SurfacePropDoc as a list of comma separated strings. Fields include: `surfaces` `weighted_surface_energy_EV_PER_ANG2` `weighted_surface_energy` `surface_anisotropy` `pretty_formula` `shape_factor` `weighted_work_function` `has_reconstructed` `material_id` `structure`
- `_all_fields` boolean — Include all fields.

## Response `200`

Search for a SurfacePropDoc

- ResponseSurfacePropDoc
  - `data` SurfacePropDoc[], nullable — List of returned data
    - `surfaces` SurfaceEntry[], nullable — List of individual surface data.
      - `miller_index` integer[], nullable — Miller index of surface.
      - `surface_energy_EV_PER_ANG2` number, nullable — Surface energy in eV/Ų.
      - `surface_energy` number, nullable — Surface energy in J/m².
      - `is_reconstructed` boolean, nullable — Whether it is a reconstructed surface.
      - `structure` TypedStructureDict — unresolved $ref
      - `work_function` number, nullable — Work function in eV.
      - `efermi` number, nullable — Fermi energy in eV.
      - `area_fraction` number, nullable — Area fraction.
      - `has_wulff` boolean, nullable — Whether the surface has wulff entry.
    - `weighted_surface_energy_EV_PER_ANG2` number, nullable — Weighted surface energy in eV/Ų
    - `weighted_surface_energy` number, nullable — Weighted surface energy in J/m²
    - `surface_anisotropy` number, nullable — Surface energy anisotropy.
    - `pretty_formula` string, nullable — Reduced Formula of the material.
    - `shape_factor` number, nullable — Shape factor.
    - `weighted_work_function` number, nullable — Weighted work function in eV.
    - `has_reconstructed` boolean, nullable — Whether the entry has any reconstructed surfaces.
    - `material_id` unknown
    - `structure` TypedStructureDict — unresolved $ref
  - `errors` Error[], nullable — Any errors on processing this query
    - `code` integer, required — The error code
    - `message` string, required — The description of the error
  - `meta` Meta — Meta information for the MAPI Response.
    - `api_version` string — A string containing the version of the Materials API implementation, e.g. v0.9.5
    - `time_stamp` string, date-time — A string containing the date and time at which the query was executed
    - `total_doc` integer, nullable — The total number of documents available for this query
    - `facet` object, nullable — A dictionary containing the facets available for this query

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/materialsproject/apis/materials-project-api.md) · [All operations](https://skmtc.net/materialsproject/apis/materials-project-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/materialsproject/materials-project-api/revisions/54f2f79ab4f8/schema)