Geofacets Search Request

A Search Request method enables a RESTful API client to perform an expert search across all or any combination of Geofacets content sources.

The input for the search request, a query string and additional search options, supports different searches available on the Geofacets web application. Help topics on doing an expert search in the web application can be found here . API documentation for the Geofacets Search API can be found in the links below.


WADL documentation
Swagger documentation


The API documentation provides details on use of advanced search options and links to the Geofacets Online Help for options that correspond to options in the Geofacets Online web application.

Getting access

Please check here here on getting an API Key for your organization. The search examples on this page work for API Key values that do IP address based authentication.

How to do a search with default options

Here is the URL syntax for doing a search without setting any advanced options

/geofacets/api/search?apiKey={apiKey}&query={query terms}

OR

[Request headers]
X-ELS-APIKey: 5135c5817a6d86b633013ee9e4d120b5
Accept: application/atom+xml

[Request URL]
/geofacets/api/search?query=rift basin&searchType=text&view=docs

Where:

--{query terms} are any applicable search field or query terms from the Geofacets expert search syntax

Processing the response from a search request

If not specified, the response from a search request is a JSON object with the MIME type application/json. Output is also available as XML by specifying an Accept header with the value application/xml.

[Request headers]
X-ELS-APIKey: {apiKey}
Accept: application/xml

[Request URL]
/geofacets/api/search?query=rift basin&searchType=text&view=docs

Here is a sample request and response for a search for items with the word "shale".

$ curl "https://api.elsevier.com/geofacets/api/search?apiKey=5135c5817a6d86b633013ee9e4d120b5&query=rift basin&searchType=text&view=docs"
{"status":{"statusCode":"OK","statusText":"Successful"},"query":{"filters":[{"id":"rift basin","removeId":"d241eb6c-e329-4f7b-abc0-a89a88845708","text":"rift basin","excluded":false},{"id":"Ba:\"East African Rift System Eastern Branch\" Ba:\"East African Rift System Western Branch\"","removeId":"f54cb1a4-1ba9-47ae-b3fb-2777900bddce","text":"ba:\"East African Rift System Eastern Branch\" ba:\"East African Rift System Western Branch\"","excluded":true},{"removeId":"d235c18e-0e72-48c6-9641-c68fb572f76e","text":"sa:\"L\"","excluded":true},{"id":"Elsevier","removeId":"6846dd0f-e497-46d3-93db-11d139fc8f03","text":"pub:\"1\" pub:\"4\"","excluded":true},{"id":"Msub:\"Geology\"","removeId":"71d297d3-2719-40e9-93d6-056969f17e8a","text":"msub:\"Geology\"","excluded":true}],"queryTerms":"(rift basin)  -((ba:(\"QQDELQQ East African Rift System Eastern Branch QQDELQQ\") OR ba:(\"QQDELQQ East African Rift System Western Branch QQDELQQ\")))  -(sa:(\"QQDELQQ L QQDELQQ\"))  -((pub:(\"QQDELQQ 1 QQDELQQ\") OR pub:(\"QQDELQQ 4 QQDELQQ\")))  -(msub:(\"QQDELQQ Geology QQDELQQ\"))"},"lastRequest":"bMghqw7a5r2LWKuYlchoAsvMzFsUw7mQUEEPSupayy0X8AWt9W7R8X0FVUi00bF6DCpBDHLrN/4ra93001S/ZPdzF5gR4r44ly3TlZOsH8VCeZHci3OtdLTRQ+AMv5+tuOgI1jr7na80n8/Ee0YBp15eDJho9hzDmzuk36nRCd8/lSVO1j99js36sJ/I+wz+AN4Spx3ZuYLXuR2yioh5j3+5DCO1Z+0Y8RbF8AadQPe3jAamvHKe885d9iV3nxj//jCpPOTtbTg/vjWzIliDDdbZkS0hWAvSFQw6OR5s2HUH4zVsYf/oFRc7lkYSl9OCRDd3Hv6wkujGdzaVyjlvjDHiXA1+Jadc6WWAu6qF6njHJJN/iw9byar4jakJ/r0pkEpgMfZPl5k3DgbS9reG4xTWj2z6EkA1e1vJAq625D9GyX2mMg8VuL3TdEP9HnpH0or/gIpgteTwiK1YG+5Q5wX+ypgkLmvJqCRv5ipAyMQQe1SjfRodg/3PxLaFqhQDwjLY2DKdWUJ6bcjgBZmZRqrWp8RHIO0EU6Wr0xFhzFPtk5Tq8rT+OI5Bpy5u4UpfjoJztQEmRT45kfISXxFsdloqHcXLEqOF8lA8N6BXVC6hL/8KdEZk7y4vnFLQQpCzFmNEPvqQ29OcuIbYBZkrRkljE9x3K0RnyYrbXMnc7drHU4kZBlei/9fR5h6oylzG4F5P9KN4VFGzRMVNWLrJRYEPGKlRCblVYH/8pmZMMrfQpHsN6Ic5zyfys4hSSe53R4aIEsqfQEN32M6noYSb74u9G6J8C1LofFOINUaHCT3jcvMd5v8c3UFHymJKYHg6mio4lW/RQwDmnfkUGoiy3VP8uHv6b35y6rAfghj3ypL3xWpRePB/SDMon9zaLqYRxK11HNZhv1/Qgx7rIUhd/Pm6gEthwj+F5IZFpeytlrbivMkOvLK9U9rB6wIrCKF8Xz532APtyStoRnFoft3G/hbfxaDwm3TNUokjRWp+RwT+cUDw/9L8cMlbouGXoJarSI6JyLhYVl3ZYynZdDn18uXE4/l3K17eCDKkHjgMGcbLm6sN/lUZOvhOM/qdNDFftb5h/p0EXkq+UqIXCG70ekySeqrmSn+r1XblLKwmBSw=","totalResults":4713,"facets":[{"id":"mapType","text":"Map Type","hasMore":true,"offset":0,"facetItems":[{"id":"Paleogeographical","text":"Paleogeographical","count":1067},{"id":"Location","text":"Location","count":1013},{"id":"Paleogeographic Reconstruction","text":"Paleogeographic Reconstruction","count":939},{"id":"Sampling Location","text":"Sampling Location","count":371},{"id":"Seismic Survey","text":"Seismic Survey","count":364}]},{"id":"surfaceArea","text":"Surface Area","hasMore":true,"offset":0,"facetItems":[{"id":"D","text":"100,000 - 1,000,000 sq km","count":632},{"id":"I","text":"Indeterminable","count":555},{"id":"K","text":"10,000 - 100,000 sq km","count":392},{"id":"M","text":"10,000,000 - 100,000,000 sq km","count":309},{"id":"N","text":"> 100,000,000 sq km (world scale)","count":198}]},{"id":"contentType","text":"Content Type","hasMore":true,"offset":0,"facetItems":[{"id":"map","text":"Map","count":2455},{"id":"section-profile","text":"Sections/Profiles","count":641},{"id":"plots-graphs","text":"Plots/Graphs","count":511},{"id":"table","text":"Tables","count":297},{"id":"stratigraphic","text":"Stratigraphic Columns/Wells/Cores","count":280}]},{"id":"subject","text":"Map Subject","hasMore":true,"offset":0,"facetItems":[{"id":"Location","text":"Location","count":2385},{"id":"Paleogeography","text":"Paleogeography","count":1790},{"id":"Geophysics","text":"Geophysics","count":735},{"id":"Oceanography","text":"Oceanography","count":651},{"id":"Geography","text":"Geography","count":216}]},{"id":"basin","text":"Basin","hasMore":true,"offset":0,"facetItems":[{"id":"Galician Basin","text":"Galician Basin","count":192},{"id":"Lusitanian Basin","text":"Lusitanian Basin","count":192},{"id":"Northwest Ireland Offshore Basin","text":"Northwest Ireland Offshore Basin","count":158},{"id":"Celtic Sea Graben System","text":"Celtic Sea Graben System","count":147},{"id":"Faroes-Shetland Trough","text":"Faroes-Shetland Trough","count":145}]},{"id":"pubYear","text":"Publication Year","hasMore":true,"offset":0,"facetItems":[{"id":"8","text":"2010-2017","count":1393},{"id":"10","text":"2000-2009","count":1750},{"id":"10","text":"1990-1999","count":1330},{"id":"10","text":"1980-1989","count":200},{"id":"8","text":"1970-1979","count":35}]},{"id":"author","text":"Author","hasMore":true,"offset":0,"facetItems":[{"id":"Kusznir N.J.","text":"Kusznir N.J.","count":75},{"id":"Henry Christopher D.","text":"Henry Christopher D.","count":59},{"id":"Davis Linda L.","text":"Davis Linda L.","count":58},{"id":"Erdlac Richard J.","text":"Erdlac Richard J.","count":58},{"id":"Kunk Michael J.","text":"Kunk Michael J.","count":58}]},{"id":"authorKeyword","text":"Author Keywords","hasMore":true,"offset":0,"facetItems":[{"id":"Magmatism","text":"Magmatism","count":108},{"id":"Rifting","text":"Rifting","count":101},{"id":"Tertiary","text":"Tertiary","count":77},{"id":"Tectonics","text":"Tectonics","count":76},{"id":"Cretaceous","text":"Cretaceous","count":72}]},{"id":"sourceTitle","text":"Source Title","hasMore":true,"offset":0,"facetItems":[{"id":"Geological Society Special Publication","text":"Geological Society Special Publication","count":1315},{"id":"Tectonics","text":"Tectonics","count":506},{"id":"Basin Research","text":"Basin Research","count":298},{"id":"Journal of the Geological Society","text":"Journal of the Geological Society","count":293},{"id":"Geochemistry, Geophysics, Geosystems","text":"Geochemistry, Geophysics, Geosystems","count":277}]},{"id":"publisher","text":"Publisher/Content Source","hasMore":true,"offset":0,"facetItems":[{"id":"0","text":"The Geological Society of London","count":2123},{"id":"6","text":"Wiley","count":1085},{"id":"7","text":"American Geophysical Union","count":974},{"id":"2","text":"SEPM Society for Sedimentary Geology","count":300},{"id":"8","text":"Society of Exploration Geophysicists","count":140}]}],"documents":[{"id":"10.2110/pec.02.73.0057_fig","doi":"10.2110/pec.02.73.0057_fig","title":"Rift-basin structure and its influence on sedimentary systems","journal":"SEPM Special Publications","volume":"73","issue":"0","pageRange":"57-82","publicationYear":"2002","publicationMonth":"January","figureCount":"17","mapCount":"8","issn":"1060071X","authors":"Withjack, Martha Oliver; Schlische, Roy W.; Olsen, Paul E.","publisher":"2"},{"id":"10.1130/0091-7613(2000)28<963:QFDTOF>2.0.CO;2_fig","doi":"10.1130/0091-7613(2000)28<963:QFDTOF>2.0.CO;2_fig","title":"Quest for dynamic topography: Observations from Southeast Asia","journal":"Geology","volume":"28","issue":"11","pageRange":"963-966","publicationYear":"2000","publicationMonth":"January","figureCount":"4","mapCount":"2","issn":"00917613","authors":"Wheeler, P.; White, N.","publisher":"4"}]}

Here is the output formatted for readability.

	{  
   "status":{  
      "statusCode":"OK",
      "statusText":"Successful"
   },
   "query":{  
      "filters":[  
         {  
            "id":"rift basin",
            "removeId":"d241eb6c-e329-4f7b-abc0-a89a88845708",
            "text":"rift basin",
            "excluded":false
         },
         {  
            "id":"Ba:\"East African Rift System Eastern Branch\" Ba:\"East African Rift System Western Branch\"",
            "removeId":"f54cb1a4-1ba9-47ae-b3fb-2777900bddce",
            "text":"ba:\"East African Rift System Eastern Branch\" ba:\"East African Rift System Western Branch\"",
            "excluded":true
         },
         {  
            "removeId":"d235c18e-0e72-48c6-9641-c68fb572f76e",
            "text":"sa:\"L\"",
            "excluded":true
         },
         {  
            "id":"Elsevier",
            "removeId":"6846dd0f-e497-46d3-93db-11d139fc8f03",
            "text":"pub:\"1\" pub:\"4\"",
            "excluded":true
         },
         {  
            "id":"Msub:\"Geology\"",
            "removeId":"71d297d3-2719-40e9-93d6-056969f17e8a",
            "text":"msub:\"Geology\"",
            "excluded":true
         }
      ],
      "queryTerms":"(rift basin)  -((ba:(\"QQDELQQ East African Rift System Eastern Branch QQDELQQ\") OR ba:(\"QQDELQQ East African Rift System Western Branch QQDELQQ\")))  -(sa:(\"QQDELQQ L QQDELQQ\"))  -((pub:(\"QQDELQQ 1 QQDELQQ\") OR pub:(\"QQDELQQ 4 QQDELQQ\")))  -(msub:(\"QQDELQQ Geology QQDELQQ\"))"
   },
   "lastRequest":"bMghqw7a5r2LWKuYlchoAsvMzFsUw7mQUEEPSupayy0X8AWt9W7R8X0FVUi00bF6DCpBDHLrN/4ra93001S/ZPdzF5gR4r44ly3TlZOsH8VCeZHci3OtdLTRQ+AMv5+tuOgI1jr7na80n8/Ee0YBp15eDJho9hzDmzuk36nRCd8/lSVO1j99js36sJ/I+wz+AN4Spx3ZuYLXuR2yioh5j3+5DCO1Z+0Y8RbF8AadQPe3jAamvHKe885d9iV3nxj//jCpPOTtbTg/vjWzIliDDdbZkS0hWAvSFQw6OR5s2HUH4zVsYf/oFRc7lkYSl9OCRDd3Hv6wkujGdzaVyjlvjDHiXA1+Jadc6WWAu6qF6njHJJN/iw9byar4jakJ/r0pkEpgMfZPl5k3DgbS9reG4xTWj2z6EkA1e1vJAq625D9GyX2mMg8VuL3TdEP9HnpH0or/gIpgteTwiK1YG+5Q5wX+ypgkLmvJqCRv5ipAyMQQe1SjfRodg/3PxLaFqhQDwjLY2DKdWUJ6bcjgBZmZRqrWp8RHIO0EU6Wr0xFhzFPtk5Tq8rT+OI5Bpy5u4UpfjoJztQEmRT45kfISXxFsdloqHcXLEqOF8lA8N6BXVC6hL/8KdEZk7y4vnFLQQpCzFmNEPvqQ29OcuIbYBZkrRkljE9x3K0RnyYrbXMnc7drHU4kZBlei/9fR5h6oylzG4F5P9KN4VFGzRMVNWLrJRYEPGKlRCblVYH/8pmZMMrfQpHsN6Ic5zyfys4hSSe53R4aIEsqfQEN32M6noYSb74u9G6J8C1LofFOINUaHCT3jcvMd5v8c3UFHymJKYHg6mio4lW/RQwDmnfkUGoiy3VP8uHv6b35y6rAfghj3ypL3xWpRePB/SDMon9zaLqYRxK11HNZhv1/Qgx7rIUhd/Pm6gEthwj+F5IZFpeytlrbivMkOvLK9U9rB6wIrCKF8Xz532APtyStoRnFoft3G/hbfxaDwm3TNUokjRWp+RwT+cUDw/9L8cMlbouGXoJarSI6JyLhYVl3ZYynZdDn18uXE4/l3K17eCDKkHjgMGcbLm6sN/lUZOvhOM/qdNDFftb5h/p0EXkq+UqIXCG70ekySeqrmSn+r1XblLKwmBSw=",
   "totalResults":4713,
   "facets":[  
      {  
         "id":"mapType",
         "text":"Map Type",
         "hasMore":true,
         "offset":0,
         "facetItems":[  
            {  
               "id":"Paleogeographical",
               "text":"Paleogeographical",
               "count":1067
            },
            {  
               "id":"Location",
               "text":"Location",
               "count":1013
            },
            {  
               "id":"Paleogeographic Reconstruction",
               "text":"Paleogeographic Reconstruction",
               "count":939
            },
            {  
               "id":"Sampling Location",
               "text":"Sampling Location",
               "count":371
            },
            {  
               "id":"Seismic Survey",
               "text":"Seismic Survey",
               "count":364
            }
         ]
      },
      {  
         "id":"surfaceArea",
         "text":"Surface Area",
         "hasMore":true,
         "offset":0,
         "facetItems":[  
            {  
               "id":"D",
               "text":"100,000 - 1,000,000 sq km",
               "count":632
            },
            {  
               "id":"I",
               "text":"Indeterminable",
               "count":555
            },
            {  
               "id":"K",
               "text":"10,000 - 100,000 sq km",
               "count":392
            },
            {  
               "id":"M",
               "text":"10,000,000 - 100,000,000 sq km",
               "count":309
            },
            {  
               "id":"N",
               "text":"> 100,000,000 sq km (world scale)",
               "count":198
            }
         ]
      },
      {  
         "id":"contentType",
         "text":"Content Type",
         "hasMore":true,
         "offset":0,
         "facetItems":[  
            {  
               "id":"map",
               "text":"Map",
               "count":2455
            },
            {  
               "id":"section-profile",
               "text":"Sections/Profiles",
               "count":641
            },
            {  
               "id":"plots-graphs",
               "text":"Plots/Graphs",
               "count":511
            },
            {  
               "id":"table",
               "text":"Tables",
               "count":297
            },
            {  
               "id":"stratigraphic",
               "text":"Stratigraphic Columns/Wells/Cores",
               "count":280
            }
         ]
      },
      {  
         "id":"subject",
         "text":"Map Subject",
         "hasMore":true,
         "offset":0,
         "facetItems":[  
            {  
               "id":"Location",
               "text":"Location",
               "count":2385
            },
            {  
               "id":"Paleogeography",
               "text":"Paleogeography",
               "count":1790
            },
            {  
               "id":"Geophysics",
               "text":"Geophysics",
               "count":735
            },
            {  
               "id":"Oceanography",
               "text":"Oceanography",
               "count":651
            },
            {  
               "id":"Geography",
               "text":"Geography",
               "count":216
            }
         ]
      },
      {  
         "id":"basin",
         "text":"Basin",
         "hasMore":true,
         "offset":0,
         "facetItems":[  
            {  
               "id":"Galician Basin",
               "text":"Galician Basin",
               "count":192
            },
            {  
               "id":"Lusitanian Basin",
               "text":"Lusitanian Basin",
               "count":192
            },
            {  
               "id":"Northwest Ireland Offshore Basin",
               "text":"Northwest Ireland Offshore Basin",
               "count":158
            },
            {  
               "id":"Celtic Sea Graben System",
               "text":"Celtic Sea Graben System",
               "count":147
            },
            {  
               "id":"Faroes-Shetland Trough",
               "text":"Faroes-Shetland Trough",
               "count":145
            }
         ]
      },
      {  
         "id":"pubYear",
         "text":"Publication Year",
         "hasMore":true,
         "offset":0,
         "facetItems":[  
            {  
               "id":"8",
               "text":"2010-2017",
               "count":1393
            },
            {  
               "id":"10",
               "text":"2000-2009",
               "count":1750
            },
            {  
               "id":"10",
               "text":"1990-1999",
               "count":1330
            },
            {  
               "id":"10",
               "text":"1980-1989",
               "count":200
            },
            {  
               "id":"8",
               "text":"1970-1979",
               "count":35
            }
         ]
      },
      {  
         "id":"author",
         "text":"Author",
         "hasMore":true,
         "offset":0,
         "facetItems":[  
            {  
               "id":"Kusznir N.J.",
               "text":"Kusznir N.J.",
               "count":75
            },
            {  
               "id":"Henry Christopher D.",
               "text":"Henry Christopher D.",
               "count":59
            },
            {  
               "id":"Davis Linda L.",
               "text":"Davis Linda L.",
               "count":58
            },
            {  
               "id":"Erdlac Richard J.",
               "text":"Erdlac Richard J.",
               "count":58
            },
            {  
               "id":"Kunk Michael J.",
               "text":"Kunk Michael J.",
               "count":58
            }
         ]
      },
      {  
         "id":"authorKeyword",
         "text":"Author Keywords",
         "hasMore":true,
         "offset":0,
         "facetItems":[  
            {  
               "id":"Magmatism",
               "text":"Magmatism",
               "count":108
            },
            {  
               "id":"Rifting",
               "text":"Rifting",
               "count":101
            },
            {  
               "id":"Tertiary",
               "text":"Tertiary",
               "count":77
            },
            {  
               "id":"Tectonics",
               "text":"Tectonics",
               "count":76
            },
            {  
               "id":"Cretaceous",
               "text":"Cretaceous",
               "count":72
            }
         ]
      },
      {  
         "id":"sourceTitle",
         "text":"Source Title",
         "hasMore":true,
         "offset":0,
         "facetItems":[  
            {  
               "id":"Geological Society Special Publication",
               "text":"Geological Society Special Publication",
               "count":1315
            },
            {  
               "id":"Tectonics",
               "text":"Tectonics",
               "count":506
            },
            {  
               "id":"Basin Research",
               "text":"Basin Research",
               "count":298
            },
            {  
               "id":"Journal of the Geological Society",
               "text":"Journal of the Geological Society",
               "count":293
            },
            {  
               "id":"Geochemistry, Geophysics, Geosystems",
               "text":"Geochemistry, Geophysics, Geosystems",
               "count":277
            }
         ]
      },
      {  
         "id":"publisher",
         "text":"Publisher/Content Source",
         "hasMore":true,
         "offset":0,
         "facetItems":[  
            {  
               "id":"0",
               "text":"The Geological Society of London",
               "count":2123
            },
            {  
               "id":"6",
               "text":"Wiley",
               "count":1085
            },
            {  
               "id":"7",
               "text":"American Geophysical Union",
               "count":974
            },
            {  
               "id":"2",
               "text":"SEPM Society for Sedimentary Geology",
               "count":300
            },
            {  
               "id":"8",
               "text":"Society of Exploration Geophysicists",
               "count":140
            }
         ]
      }
   ],
   "documents":[  
      {  
         "id":"10.2110/pec.02.73.0057_fig",
         "doi":"10.2110/pec.02.73.0057_fig",
         "title":"Rift-basin structure and its influence on sedimentary systems",
         "journal":"SEPM Special Publications",
         "volume":"73",
         "issue":"0",
         "pageRange":"57-82",
         "publicationYear":"2002",
         "publicationMonth":"January",
         "figureCount":"17",
         "mapCount":"8",
         "issn":"1060071X",
         "authors":"Withjack, Martha Oliver; Schlische, Roy W.; Olsen, Paul E.",
         "publisher":"2"
      },
      {  
         "id":"10.1130/0091-7613(2000)28<963:QFDTOF>2.0.CO;2_fig",
         "doi":"10.1130/0091-7613(2000)28<963:QFDTOF>2.0.CO;2_fig",
         "title":"Quest for dynamic topography: Observations from Southeast Asia",
         "journal":"Geology",
         "volume":"28",
         "issue":"11",
         "pageRange":"963-966",
         "publicationYear":"2000",
         "publicationMonth":"January",
         "figureCount":"4",
         "mapCount":"2",
         "issn":"00917613",
         "authors":"Wheeler, P.; White, N.",
         "publisher":"4"
      }
   ]
}