MSD includes a collection of APIs to provide developers with access to Master Survey Database (MSD).
The tutorials section explains the functionality of the MSD APIs and briefly walks through examples of the APIs provided by the corresponding services.
- The request is throttled per client ID. The API accept(s) 10 requests per second per client ID.
- For the Get Structure API, either a service token or a DrillPlan-access user token(except a guest user token) should be used.
- For other GET or CREATE APIs, either a user token or a service token should be used. If a user token is used, the user must have admin access to MSD.
- Structure: A Structure is the permanent foundation or base through which one or multiple wells are drilled, supporting the drilling rig or workover operation. "Structures" include well pads (onshore wells), platforms, templates, subsea wellheads (offshore wells), etc.
- Slot: Each slot is a specific position on the structure where drilling equipment can be set up to initiate and manage the drilling of a well. Drilling pad or Offshore platforms are often designed with multiple slots to allow for the drilling of several wells from the same structure. Once a well is drilled, the wellhead is installed at the slot. This is the surface termination of the well, where control equipment and safety devices are attached.
- Well: A well is a surface location drilled to explore, develop, or produce resources (such as oil, gas, or geothermal energy) from a subsurface reservoir. It is a high-level entity that encompasses all activities and data associated with drilling, completing, and producing. A well can have one or more wellbores associated with it, representing different paths drilled from the surface location.
- Wellbore: A wellbore is a specific hole drilled by a drill bit to access the subsurface reservoir. It is a more detailed entity within a well, representing the physical borehole drilled from the surface down to the target zone. A single well can have multiple wellbores, such as in the case of sidetracks, re-drills, or multi-lateral wells. Each wellbore has its own trajectory and associated data.
- Wellbore survey: A Wellbore survey refers to the collection of data that describes the trajectory of a wellbore as it is drilled. This data is critical for understanding the exact path that the drill bit has taken from the surface to the target zones in the subsurface. Wellbore survey data typically includes measurements of inclination, azimuth, and depth, which together define the three-dimensional geometry of the wellbore.
- Get wellbore API: "parent_wellbore_id", "external_tag".
- Get survey API: "survey_date", "geomag_settings", "hole_section", "tie_in" and "external_tag".
- API to create a structure
- API to create a well
- API to create a wellbore
- API to create a survey
Field units are given in SI by default, except for fields northing, easting, latitude and longitude, which use specified units as detailed in the table below. The non-SI units are specified in the 'Description' column.
| Field | Unit | Description |
|---|---|---|
| azi/azimuth | radian (rad) | |
| casing_size | meter (m) | |
| confidence | unitless | |
| declination | radian (rad) | |
| declination_date | UTC date | Example: 2025-03-15T12:34:56Z |
| diameter | meter (m) | |
| dip_angle | radian (rad) | |
| dls | rad/m | |
| distance | meter (m) | |
| easting | Same as CRS unit | |
| end_md | meter (m) | |
| ew | meter (m) | |
| field_strength | tesla (T) | |
| ground_level | meter (m) | |
| grid_convergence | radian (rad) | |
| hole_size | meter (m) | |
| incl | radian (rad) | |
| latitude | degree (°) | not SI; decimal degrees. Example: −33.8688° |
| longitude | degree (°) | not SI; decimal degrees. Example: -74.0060° |
| md | meter (m) | |
| northing | Same as CRS unit | |
| ns | meter (m) | |
| radius | meter (m) | |
| scale_factor | unitless | |
| survey_date | UTC date | Example: 2025-03-15T12:34:56Z |
| tie_in_md | meter (m) | |
| tvd | meter (m) |