Introduction

Welcome to the Profiscope Search API.

Authentication

To authorize, use this code:

curl "http://www.profiscope.net/api/v1/?api_key=34093aec-a8e2-4618-90d8-143924d6c6a4"

Response example

  {
    "profile_views_total": 4, 
    "api_key": "34093aec-a8e2-4618-90d8-143924d6c6a4", 
    "email": "user@example.com"
  }

To get API key you should be registered at Profiscope. Just go to the profile settings and copy that.

API key is a simple uuid, like 34093aec-a8e2-4618-90d8-143924d6c6a4.

References

Get all languages

curl "http://www.profiscope.net/api/v1/languages/?api_key=34093aec-a8e2-4618-90d8-143924d6c6a4"

Response example

  {
    "languages": 
      [
        "ABAP", 
        "AGS Script", 
        "AMPL", 
        "ANTLR", 
        "API Blueprint", 
        "APL", 
        "ASP", 
        "ATS", 
        "ActionScript", 
        "Ada", 
        "Brightscript", 
        "Bro", 
        "C", 
        "C#", 
        "C++", 
        "Python",
        "..."
        "xBase"
      ]
  }

HTTP Request

GET http://www.profiscope.net/api/v1/languages/

Query Parameters

Parameter	Description
api_key	Your api key.

Get all occupations

curl "http://www.profiscope.net/api/v1/occupations/?api_key=34093aec-a8e2-4618-90d8-143924d6c6a4"

Response example

  {
    "occupations": 
      [
        "Backend developer", 
        "Data scientist", 
        "DevOps", 
        "Frontend developer", 
        "Game developer", 
        "Hardware engineer", 
        "Information security", 
        "Mobile developer", 
        "Quality assurance"
      ]
  }

HTTP Request

GET http://www.profiscope.net/api/v1/occupations/

Query Parameters

Parameter	Description
api_key	Your api key.

Get all backgrounds

curl "http://www.profiscope.net/api/v1/backgrounds/?api_key=34093aec-a8e2-4618-90d8-143924d6c6a4"

Response example

  {
    "backgrounds": 
      [
        "Astronomy", 
        "Bioinformatics", 
        "Chemistry", 
        "Earth Sciences", 
        "Education", 
        "Engineering/Robotics", 
        "Healthcare", 
        "Math", 
        "Physics"
      ]
  }

HTTP Request

GET http://www.profiscope.net/api/v1/backgrounds/

Query Parameters

Parameter	Description
api_key	Your api key.

Get all keywords

curl "http://www.profiscope.net/api/v1/keywords/?api_key=34093aec-a8e2-4618-90d8-143924d6c6a4"

Response example

  {
    "keywords": 
      [
        "3d engines", 
        "3d meshes", 
        "3dsmax", 
        "active directory", 
        "activemq", 
        "activerecord", 
        "activex", 
        "adb", 
        "admob", 
        "aes", 
        "afnetworking", 
        "agile testing", 
        "wpf controls", 
        "wso2", 
        "wxpython", 
        "wysiwyg", 
        "xamarin",
        "...", 
        "zend framework", 
        "zero day", 
        "zeromq", 
        "zf", 
        "zurb foundation", 
        "zxing"
      ]
  }

HTTP Request

GET http://www.profiscope.net/api/v1/keywords/

Query Parameters

Parameter	Description
api_key	Your api key.

Search profiles

curl "http://www.profiscope.net/api/v1/search/?api_key=34093aec-a8e2-4618-90d8-143924d6c6a4&languages=Python&location=Berlin"

Response example

{
  "profiles_count": 1302,
  "profiles": [
    {
      "scores": {
        "occupations": [
          [
            "Backend developer",
            60
          ],
          [
            "Data scientist",
            25
          ],
          [
            "DevOps",
            7
          ],
          [
            "Frontend developer",
            1
          ],
          [
            "Quality assurance",
            1
          ]
        ],
        "backgrounds": [
          [
            "Education",
            10
          ],
          [
            "Math",
            4
          ],
          [
            "Healthcare",
            1
          ]
        ],
        "languages": [
          [
            "Python",
            8.635685689085998
          ],
          [
            "C",
            6.436694349316593
          ],
          [
            "JavaScript",
            5.476444006895386
          ],
          [
            "TeX",
            5.307351584204118
          ],
          [
            "Shell",
            4.7619009848011755
          ]
        ]
      },
      "is_hireable": true,
      "works_for": "Freelance",
      "id_sha": "632eea3d79b08be64529344bff67222300879be4"
    },
  ]
}

HTTP Request

GET http://www.profiscope.net/api/v1/search/

Query Parameters

Parameter	Required	Description
api_key	Yes	Your api key.
languages	Yes	Languages from references.
location	Yes	Location, e.g. San-Francisco or Germany.
occupations	No	Occupations from references.
backgrounds	No	Backgrounds from references.
keywords	No	Keywords from references.
full_text	No	Any string query, can be email or name of candidate.
start	No	Left bound of the slice (independent of stop parameter).
stop	No	Right bound of the slice (independent of start parameter).

Get search result page length only

curl "http://www.profiscope.net/api/v1/search_count/?api_key=34093aec-a8e2-4618-90d8-143924d6c6a4&languages=Python&location=Berlin"

Response example

{ 
  "profiles_count": 1302
}

HTTP Request

GET http://www.profiscope.net/api/v1/search_count/

Query Parameters

Parameter	Required	Description
api_key	Yes	Your api key.
languages	Yes	Languages from references.
location	Yes	Location, e.g. San-Francisco or Germany.
occupations	No	Occupations from references.
backgrounds	No	Backgrounds from references.
keywords	No	Keywords from references.
full_text	No	Any string query, can be email or name of candidate.
start	No	Left bound of the slice (independent of stop parameter).
stop	No	Right bound of the slice (independent of start parameter).

View profile

curl "http://www.profiscope.net/api/v1/profile_basic/632eea3d79b08be64529344bff67222300879be4/?api_key=34093aec-a8e2-4618-90d8-143924d6c6a4"

Response example

{
  "location_predicted": {
    "country": "Germany",
    "state": "Berlin",
    "city": "Berlin"
  },
  "names": [
    "First Last names"
  ],
  "natural_languages": [
    "German",
    "English"
  ],
  "id_sha": "632eea3d79b08be64529344bff67222300879be4",
  "name": "First Last names",
  "works_for": "Freelance",
  "bitbucket_link": "https://bitbucket.org/username",
  "is_hireable": true,
  "github_link": "https://github.com/username",
  "location": "Germany, Berlin, Berlin",
  "language_scores": [
    [
      "Python",
      8.635685689085998
    ],
    [
      "C",
      6.436694349316593
    ],
    [
      "JavaScript",
      5.476444006895386
    ],
    [
      "TeX",
      5.307351584204118
    ],
    [
      "Shell",
      4.7619009848011755
    ]
  ],
  "emails": [
    "username@example.de",
    "username@example.co"
  ],
  "language_using_time": {
    "Go": [
      "2011-05-02T11:44:28",
      "2011-05-05T16:48:48"
    ],
    "R": [
      "2011-07-04T10:39:06",
      "2015-03-15T11:48:13"
    ],
    "Python": [
      "2009-03-02T19:02:51",
      "2016-01-13T12:25:56"
    ],
    "Assembly": [
      "2011-04-26T09:34:18",
      "2014-01-28T15:42:05"
    ],
    "Shell": [
      "2009-03-02T19:02:51",
      "2015-12-10T19:48:06"
    ],
    "Groff": [
      "2011-05-02T11:44:28",
      "2014-03-12T13:29:19"
    ],
    "Java": [
      "2011-09-02T08:45:56",
      "2011-09-02T08:45:56"
    ],
    "Emacs Lisp": [
      "2011-04-25T19:36:15",
      "2015-01-12T16:33:55"
    ],
    "JavaScript": [
      "2011-02-21T14:25:30",
      "2015-11-10T10:50:05"
    ],
    "Ruby": [
      "2011-06-27T12:45:33",
      "2015-05-30T03:53:36"
    ],
    "C": [
      "2009-03-19T11:08:42",
      "2015-08-28T05:21:15"
    ],
    "D": [
      "2014-03-06T12:21:30",
      "2014-03-12T13:29:19"
    ],
    "XSLT": [
      "2011-04-26T09:34:18",
      "2011-05-05T19:58:18"
    ],
    "Makefile": [
      "2010-03-05T19:52:10",
      "2015-12-10T19:48:06"
    ],
    "C++": [
      "2009-03-19T11:08:42",
      "2015-08-16T09:12:42"
    ],
    "TeX": [
      "2010-03-05T19:52:10",
      "2015-05-29T19:28:28"
    ],
    "FORTRAN": [
      "2011-02-21T14:25:30",
      "2015-08-28T05:21:15"
    ],
  },
  "scores": {
    "occupations": [
      [
        "Backend developer",
        60
      ],
      [
        "Data scientist",
        25
      ],
      [
        "DevOps",
        7
      ],
      [
        "Frontend developer",
        1
      ],
      [
        "Quality assurance",
        1
      ]
    ],
    "backgrounds": [
      [
        "Education",
        10
      ],
      [
        "Math",
        4
      ],
      [
        "Healthcare",
        1
      ]
    ],
    "keywords": [
      [
        "python",
        47
      ],
      [
        "numpy",
        10
      ],
      [
        "ipython",
        5
      ],
      [
        "r",
        4
      ],
      [
        "c#",
        3
      ],
      [
        "c",
        3
      ],
      [
        "c++",
        3
      ],
      [
        "latex",
        2
      ],
      [
        "llvm",
        2
      ],
      [
        "ipython notebook",
        2
      ],
      [
        "deployment",
        2
      ],
      [
        "machine learning",
        2
      ],
    ]
  },
  "repos": [
    {
      "name": "scipy-lecture-notes",
      "last_commit_at": "2015-08-28T05:21:15",
      "occupations": [
        "Backend developer"
      ],
      "user_commit_count": 210,
      "keywords": [
        "python"
      ],
      "team_size": 30,
      "first_commit_at": "2011-02-21T14:25:30",
      "identified_data": {
        "language_involvement": [
          [
            "HTML",
            0.010749692526177744
          ],
          [
            "C",
            0.15718650693882913
          ],
          [
            "Shell",
            0.012283097886528004
          ],
          [
            "Python",
            0.8022495985286556
          ],
          [
            "JavaScript",
            0.00570553634080104
          ],
          [
            "FORTRAN",
            0.00043261510166454887
          ],
          [
            "Makefile",
            0.011392952677343878
          ]
        ],
        "team_size": 30
      },
      "author": "scipy-lectures",
      "description": "Tutorial material on the scientific Python ecosystem",
      "community": "github",
      "languages": [
        "HTML",
        "C",
        "Shell",
        "Python",
        "JavaScript",
        "FORTRAN",
        "Makefile"
      ],
      "user_involvement_time": [
        "2011-02-21T14:25:30",
        "2015-08-28T05:21:15"
      ]
    },
  ],
}

HTTP Request

GET http://www.profiscope.net/api/v1/profile_basic/id_sha/

Query Parameters

Parameter	Required	Description
api_key	Yes	Your api key.